bootstrap.inc 133 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879
  1. <?php
  2. /**
  3. * @file
  4. * Functions that need to be loaded on every Drupal request.
  5. */
  6. /**
  7. * The current system version.
  8. */
  9. define('VERSION', '7.69');
  10. /**
  11. * Core API compatibility.
  12. */
  13. define('DRUPAL_CORE_COMPATIBILITY', '7.x');
  14. /**
  15. * Minimum supported version of PHP.
  16. */
  17. define('DRUPAL_MINIMUM_PHP', '5.2.4');
  18. /**
  19. * Minimum recommended value of PHP memory_limit.
  20. */
  21. define('DRUPAL_MINIMUM_PHP_MEMORY_LIMIT', '32M');
  22. /**
  23. * Error reporting level: display no errors.
  24. */
  25. define('ERROR_REPORTING_HIDE', 0);
  26. /**
  27. * Error reporting level: display errors and warnings.
  28. */
  29. define('ERROR_REPORTING_DISPLAY_SOME', 1);
  30. /**
  31. * Error reporting level: display all messages.
  32. */
  33. define('ERROR_REPORTING_DISPLAY_ALL', 2);
  34. /**
  35. * Indicates that the item should never be removed unless explicitly selected.
  36. *
  37. * The item may be removed using cache_clear_all() with a cache ID.
  38. */
  39. define('CACHE_PERMANENT', 0);
  40. /**
  41. * Indicates that the item should be removed at the next general cache wipe.
  42. */
  43. define('CACHE_TEMPORARY', -1);
  44. /**
  45. * @defgroup logging_severity_levels Logging severity levels
  46. * @{
  47. * Logging severity levels as defined in RFC 3164.
  48. *
  49. * The WATCHDOG_* constant definitions correspond to the logging severity levels
  50. * defined in RFC 3164, section 4.1.1. PHP supplies predefined LOG_* constants
  51. * for use in the syslog() function, but their values on Windows builds do not
  52. * correspond to RFC 3164. The associated PHP bug report was closed with the
  53. * comment, "And it's also not a bug, as Windows just have less log levels,"
  54. * and "So the behavior you're seeing is perfectly normal."
  55. *
  56. * @see http://www.faqs.org/rfcs/rfc3164.html
  57. * @see http://bugs.php.net/bug.php?id=18090
  58. * @see http://php.net/manual/function.syslog.php
  59. * @see http://php.net/manual/network.constants.php
  60. * @see watchdog()
  61. * @see watchdog_severity_levels()
  62. */
  63. /**
  64. * Log message severity -- Emergency: system is unusable.
  65. */
  66. define('WATCHDOG_EMERGENCY', 0);
  67. /**
  68. * Log message severity -- Alert: action must be taken immediately.
  69. */
  70. define('WATCHDOG_ALERT', 1);
  71. /**
  72. * Log message severity -- Critical conditions.
  73. */
  74. define('WATCHDOG_CRITICAL', 2);
  75. /**
  76. * Log message severity -- Error conditions.
  77. */
  78. define('WATCHDOG_ERROR', 3);
  79. /**
  80. * Log message severity -- Warning conditions.
  81. */
  82. define('WATCHDOG_WARNING', 4);
  83. /**
  84. * Log message severity -- Normal but significant conditions.
  85. */
  86. define('WATCHDOG_NOTICE', 5);
  87. /**
  88. * Log message severity -- Informational messages.
  89. */
  90. define('WATCHDOG_INFO', 6);
  91. /**
  92. * Log message severity -- Debug-level messages.
  93. */
  94. define('WATCHDOG_DEBUG', 7);
  95. /**
  96. * @} End of "defgroup logging_severity_levels".
  97. */
  98. /**
  99. * First bootstrap phase: initialize configuration.
  100. */
  101. define('DRUPAL_BOOTSTRAP_CONFIGURATION', 0);
  102. /**
  103. * Second bootstrap phase: try to serve a cached page.
  104. */
  105. define('DRUPAL_BOOTSTRAP_PAGE_CACHE', 1);
  106. /**
  107. * Third bootstrap phase: initialize database layer.
  108. */
  109. define('DRUPAL_BOOTSTRAP_DATABASE', 2);
  110. /**
  111. * Fourth bootstrap phase: initialize the variable system.
  112. */
  113. define('DRUPAL_BOOTSTRAP_VARIABLES', 3);
  114. /**
  115. * Fifth bootstrap phase: initialize session handling.
  116. */
  117. define('DRUPAL_BOOTSTRAP_SESSION', 4);
  118. /**
  119. * Sixth bootstrap phase: set up the page header.
  120. */
  121. define('DRUPAL_BOOTSTRAP_PAGE_HEADER', 5);
  122. /**
  123. * Seventh bootstrap phase: find out language of the page.
  124. */
  125. define('DRUPAL_BOOTSTRAP_LANGUAGE', 6);
  126. /**
  127. * Final bootstrap phase: Drupal is fully loaded; validate and fix input data.
  128. */
  129. define('DRUPAL_BOOTSTRAP_FULL', 7);
  130. /**
  131. * Role ID for anonymous users; should match what's in the "role" table.
  132. */
  133. define('DRUPAL_ANONYMOUS_RID', 1);
  134. /**
  135. * Role ID for authenticated users; should match what's in the "role" table.
  136. */
  137. define('DRUPAL_AUTHENTICATED_RID', 2);
  138. /**
  139. * The number of bytes in a kilobyte.
  140. *
  141. * For more information, visit http://en.wikipedia.org/wiki/Kilobyte.
  142. */
  143. define('DRUPAL_KILOBYTE', 1024);
  144. /**
  145. * The language code used when no language is explicitly assigned.
  146. *
  147. * Defined by ISO639-2 for "Undetermined".
  148. */
  149. define('LANGUAGE_NONE', 'und');
  150. /**
  151. * The type of language used to define the content language.
  152. */
  153. define('LANGUAGE_TYPE_CONTENT', 'language_content');
  154. /**
  155. * The type of language used to select the user interface.
  156. */
  157. define('LANGUAGE_TYPE_INTERFACE', 'language');
  158. /**
  159. * The type of language used for URLs.
  160. */
  161. define('LANGUAGE_TYPE_URL', 'language_url');
  162. /**
  163. * Language written left to right. Possible value of $language->direction.
  164. */
  165. define('LANGUAGE_LTR', 0);
  166. /**
  167. * Language written right to left. Possible value of $language->direction.
  168. */
  169. define('LANGUAGE_RTL', 1);
  170. /**
  171. * Time of the current request in seconds elapsed since the Unix Epoch.
  172. *
  173. * This differs from $_SERVER['REQUEST_TIME'], which is stored as a float
  174. * since PHP 5.4.0. Float timestamps confuse most PHP functions
  175. * (including date_create()).
  176. *
  177. * @see http://php.net/manual/reserved.variables.server.php
  178. * @see http://php.net/manual/function.time.php
  179. */
  180. define('REQUEST_TIME', (int) $_SERVER['REQUEST_TIME']);
  181. /**
  182. * Flag used to indicate that text is not sanitized, so run check_plain().
  183. *
  184. * @see drupal_set_title()
  185. */
  186. define('CHECK_PLAIN', 0);
  187. /**
  188. * Flag used to indicate that text has already been sanitized.
  189. *
  190. * @see drupal_set_title()
  191. */
  192. define('PASS_THROUGH', -1);
  193. /**
  194. * Signals that the registry lookup cache should be reset.
  195. */
  196. define('REGISTRY_RESET_LOOKUP_CACHE', 1);
  197. /**
  198. * Signals that the registry lookup cache should be written to storage.
  199. */
  200. define('REGISTRY_WRITE_LOOKUP_CACHE', 2);
  201. /**
  202. * Regular expression to match PHP function names.
  203. *
  204. * @see http://php.net/manual/language.functions.php
  205. */
  206. define('DRUPAL_PHP_FUNCTION_PATTERN', '[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*');
  207. /**
  208. * A RFC7231 Compliant date.
  209. *
  210. * http://tools.ietf.org/html/rfc7231#section-7.1.1.1
  211. *
  212. * Example: Sun, 06 Nov 1994 08:49:37 GMT
  213. *
  214. * This constant was introduced in PHP 7.0.19 and PHP 7.1.5 but needs to be
  215. * defined by Drupal for earlier PHP versions.
  216. */
  217. if (!defined('DATE_RFC7231')) {
  218. define('DATE_RFC7231', 'D, d M Y H:i:s \G\M\T');
  219. }
  220. /**
  221. * Provides a caching wrapper to be used in place of large array structures.
  222. *
  223. * This class should be extended by systems that need to cache large amounts
  224. * of data and have it represented as an array to calling functions. These
  225. * arrays can become very large, so ArrayAccess is used to allow different
  226. * strategies to be used for caching internally (lazy loading, building caches
  227. * over time etc.). This can dramatically reduce the amount of data that needs
  228. * to be loaded from cache backends on each request, and memory usage from
  229. * static caches of that same data.
  230. *
  231. * Note that array_* functions do not work with ArrayAccess. Systems using
  232. * DrupalCacheArray should use this only internally. If providing API functions
  233. * that return the full array, this can be cached separately or returned
  234. * directly. However since DrupalCacheArray holds partial content by design, it
  235. * should be a normal PHP array or otherwise contain the full structure.
  236. *
  237. * Note also that due to limitations in PHP prior to 5.3.4, it is impossible to
  238. * write directly to the contents of nested arrays contained in this object.
  239. * Only writes to the top-level array elements are possible. So if you
  240. * previously had set $object['foo'] = array(1, 2, 'bar' => 'baz'), but later
  241. * want to change the value of 'bar' from 'baz' to 'foobar', you cannot do so
  242. * a targeted write like $object['foo']['bar'] = 'foobar'. Instead, you must
  243. * overwrite the entire top-level 'foo' array with the entire set of new
  244. * values: $object['foo'] = array(1, 2, 'bar' => 'foobar'). Due to this same
  245. * limitation, attempts to create references to any contained data, nested or
  246. * otherwise, will fail silently. So $var = &$object['foo'] will not throw an
  247. * error, and $var will be populated with the contents of $object['foo'], but
  248. * that data will be passed by value, not reference. For more information on
  249. * the PHP limitation, see the note in the official PHP documentation at·
  250. * http://php.net/manual/arrayaccess.offsetget.php on
  251. * ArrayAccess::offsetGet().
  252. *
  253. * By default, the class accounts for caches where calling functions might
  254. * request keys in the array that won't exist even after a cache rebuild. This
  255. * prevents situations where a cache rebuild would be triggered over and over
  256. * due to a 'missing' item. These cases are stored internally as a value of
  257. * NULL. This means that the offsetGet() and offsetExists() methods
  258. * must be overridden if caching an array where the top level values can
  259. * legitimately be NULL, and where $object->offsetExists() needs to correctly
  260. * return (equivalent to array_key_exists() vs. isset()). This should not
  261. * be necessary in the majority of cases.
  262. *
  263. * Classes extending this class must override at least the
  264. * resolveCacheMiss() method to have a working implementation.
  265. *
  266. * offsetSet() is not overridden by this class by default. In practice this
  267. * means that assigning an offset via arrayAccess will only apply while the
  268. * object is in scope and will not be written back to the persistent cache.
  269. * This follows a similar pattern to static vs. persistent caching in
  270. * procedural code. Extending classes may wish to alter this behavior, for
  271. * example by overriding offsetSet() and adding an automatic call to persist().
  272. *
  273. * @see SchemaCache
  274. */
  275. abstract class DrupalCacheArray implements ArrayAccess {
  276. /**
  277. * A cid to pass to cache_set() and cache_get().
  278. */
  279. protected $cid;
  280. /**
  281. * A bin to pass to cache_set() and cache_get().
  282. */
  283. protected $bin;
  284. /**
  285. * An array of keys to add to the cache at the end of the request.
  286. */
  287. protected $keysToPersist = array();
  288. /**
  289. * Storage for the data itself.
  290. */
  291. protected $storage = array();
  292. /**
  293. * Constructs a DrupalCacheArray object.
  294. *
  295. * @param $cid
  296. * The cid for the array being cached.
  297. * @param $bin
  298. * The bin to cache the array.
  299. */
  300. public function __construct($cid, $bin) {
  301. $this->cid = $cid;
  302. $this->bin = $bin;
  303. if ($cached = cache_get($this->cid, $this->bin)) {
  304. $this->storage = $cached->data;
  305. }
  306. }
  307. /**
  308. * Implements ArrayAccess::offsetExists().
  309. */
  310. public function offsetExists($offset) {
  311. return $this->offsetGet($offset) !== NULL;
  312. }
  313. /**
  314. * Implements ArrayAccess::offsetGet().
  315. */
  316. public function offsetGet($offset) {
  317. if (isset($this->storage[$offset]) || array_key_exists($offset, $this->storage)) {
  318. return $this->storage[$offset];
  319. }
  320. else {
  321. return $this->resolveCacheMiss($offset);
  322. }
  323. }
  324. /**
  325. * Implements ArrayAccess::offsetSet().
  326. */
  327. public function offsetSet($offset, $value) {
  328. $this->storage[$offset] = $value;
  329. }
  330. /**
  331. * Implements ArrayAccess::offsetUnset().
  332. */
  333. public function offsetUnset($offset) {
  334. unset($this->storage[$offset]);
  335. }
  336. /**
  337. * Flags an offset value to be written to the persistent cache.
  338. *
  339. * If a value is assigned to a cache object with offsetSet(), by default it
  340. * will not be written to the persistent cache unless it is flagged with this
  341. * method. This allows items to be cached for the duration of a request,
  342. * without necessarily writing back to the persistent cache at the end.
  343. *
  344. * @param $offset
  345. * The array offset that was requested.
  346. * @param $persist
  347. * Optional boolean to specify whether the offset should be persisted or
  348. * not, defaults to TRUE. When called with $persist = FALSE the offset will
  349. * be unflagged so that it will not be written at the end of the request.
  350. */
  351. protected function persist($offset, $persist = TRUE) {
  352. $this->keysToPersist[$offset] = $persist;
  353. }
  354. /**
  355. * Resolves a cache miss.
  356. *
  357. * When an offset is not found in the object, this is treated as a cache
  358. * miss. This method allows classes implementing the interface to look up
  359. * the actual value and allow it to be cached.
  360. *
  361. * @param $offset
  362. * The offset that was requested.
  363. *
  364. * @return
  365. * The value of the offset, or NULL if no value was found.
  366. */
  367. abstract protected function resolveCacheMiss($offset);
  368. /**
  369. * Writes a value to the persistent cache immediately.
  370. *
  371. * @param $data
  372. * The data to write to the persistent cache.
  373. * @param $lock
  374. * Whether to acquire a lock before writing to cache.
  375. */
  376. protected function set($data, $lock = TRUE) {
  377. // Lock cache writes to help avoid stampedes.
  378. // To implement locking for cache misses, override __construct().
  379. $lock_name = $this->cid . ':' . $this->bin;
  380. if (!$lock || lock_acquire($lock_name)) {
  381. if ($cached = cache_get($this->cid, $this->bin)) {
  382. $data = $cached->data + $data;
  383. }
  384. cache_set($this->cid, $data, $this->bin);
  385. if ($lock) {
  386. lock_release($lock_name);
  387. }
  388. }
  389. }
  390. /**
  391. * Destructs the DrupalCacheArray object.
  392. */
  393. public function __destruct() {
  394. $data = array();
  395. foreach ($this->keysToPersist as $offset => $persist) {
  396. if ($persist) {
  397. $data[$offset] = $this->storage[$offset];
  398. }
  399. }
  400. if (!empty($data)) {
  401. $this->set($data);
  402. }
  403. }
  404. }
  405. /**
  406. * Starts the timer with the specified name.
  407. *
  408. * If you start and stop the same timer multiple times, the measured intervals
  409. * will be accumulated.
  410. *
  411. * @param $name
  412. * The name of the timer.
  413. */
  414. function timer_start($name) {
  415. global $timers;
  416. $timers[$name]['start'] = microtime(TRUE);
  417. $timers[$name]['count'] = isset($timers[$name]['count']) ? ++$timers[$name]['count'] : 1;
  418. }
  419. /**
  420. * Reads the current timer value without stopping the timer.
  421. *
  422. * @param $name
  423. * The name of the timer.
  424. *
  425. * @return
  426. * The current timer value in ms.
  427. */
  428. function timer_read($name) {
  429. global $timers;
  430. if (isset($timers[$name]['start'])) {
  431. $stop = microtime(TRUE);
  432. $diff = round(($stop - $timers[$name]['start']) * 1000, 2);
  433. if (isset($timers[$name]['time'])) {
  434. $diff += $timers[$name]['time'];
  435. }
  436. return $diff;
  437. }
  438. return $timers[$name]['time'];
  439. }
  440. /**
  441. * Stops the timer with the specified name.
  442. *
  443. * @param $name
  444. * The name of the timer.
  445. *
  446. * @return
  447. * A timer array. The array contains the number of times the timer has been
  448. * started and stopped (count) and the accumulated timer value in ms (time).
  449. */
  450. function timer_stop($name) {
  451. global $timers;
  452. if (isset($timers[$name]['start'])) {
  453. $stop = microtime(TRUE);
  454. $diff = round(($stop - $timers[$name]['start']) * 1000, 2);
  455. if (isset($timers[$name]['time'])) {
  456. $timers[$name]['time'] += $diff;
  457. }
  458. else {
  459. $timers[$name]['time'] = $diff;
  460. }
  461. unset($timers[$name]['start']);
  462. }
  463. return $timers[$name];
  464. }
  465. /**
  466. * Returns the appropriate configuration directory.
  467. *
  468. * Returns the configuration path based on the site's hostname, port, and
  469. * pathname. See default.settings.php for examples on how the URL is converted
  470. * to a directory.
  471. *
  472. * @param bool $require_settings
  473. * Only configuration directories with an existing settings.php file
  474. * will be recognized. Defaults to TRUE. During initial installation,
  475. * this is set to FALSE so that Drupal can detect a matching directory,
  476. * then create a new settings.php file in it.
  477. * @param bool $reset
  478. * Force a full search for matching directories even if one had been
  479. * found previously. Defaults to FALSE.
  480. *
  481. * @return
  482. * The path of the matching directory.
  483. *
  484. * @see default.settings.php
  485. */
  486. function conf_path($require_settings = TRUE, $reset = FALSE) {
  487. $conf = &drupal_static(__FUNCTION__, '');
  488. if ($conf && !$reset) {
  489. return $conf;
  490. }
  491. $confdir = 'sites';
  492. $sites = array();
  493. if (file_exists(DRUPAL_ROOT . '/' . $confdir . '/sites.php')) {
  494. // This will overwrite $sites with the desired mappings.
  495. include(DRUPAL_ROOT . '/' . $confdir . '/sites.php');
  496. }
  497. $uri = explode('/', $_SERVER['SCRIPT_NAME'] ? $_SERVER['SCRIPT_NAME'] : $_SERVER['SCRIPT_FILENAME']);
  498. $server = explode('.', implode('.', array_reverse(explode(':', rtrim($_SERVER['HTTP_HOST'], '.')))));
  499. for ($i = count($uri) - 1; $i > 0; $i--) {
  500. for ($j = count($server); $j > 0; $j--) {
  501. $dir = implode('.', array_slice($server, -$j)) . implode('.', array_slice($uri, 0, $i));
  502. if (isset($sites[$dir]) && file_exists(DRUPAL_ROOT . '/' . $confdir . '/' . $sites[$dir])) {
  503. $dir = $sites[$dir];
  504. }
  505. if (file_exists(DRUPAL_ROOT . '/' . $confdir . '/' . $dir . '/settings.php') || (!$require_settings && file_exists(DRUPAL_ROOT . '/' . $confdir . '/' . $dir))) {
  506. $conf = "$confdir/$dir";
  507. return $conf;
  508. }
  509. }
  510. }
  511. $conf = "$confdir/default";
  512. return $conf;
  513. }
  514. /**
  515. * Sets appropriate server variables needed for command line scripts to work.
  516. *
  517. * This function can be called by command line scripts before bootstrapping
  518. * Drupal, to ensure that the page loads with the desired server parameters.
  519. * This is because many parts of Drupal assume that they are running in a web
  520. * browser and therefore use information from the global PHP $_SERVER variable
  521. * that does not get set when Drupal is run from the command line.
  522. *
  523. * In many cases, the default way in which this function populates the $_SERVER
  524. * variable is sufficient, and it can therefore be called without passing in
  525. * any input. However, command line scripts running on a multisite installation
  526. * (or on any installation that has settings.php stored somewhere other than
  527. * the sites/default folder) need to pass in the URL of the site to allow
  528. * Drupal to detect the correct location of the settings.php file. Passing in
  529. * the 'url' parameter is also required for functions like request_uri() to
  530. * return the expected values.
  531. *
  532. * Most other parameters do not need to be passed in, but may be necessary in
  533. * some cases; for example, if Drupal's ip_address() function needs to return
  534. * anything but the standard localhost value ('127.0.0.1'), the command line
  535. * script should pass in the desired value via the 'REMOTE_ADDR' key.
  536. *
  537. * @param $variables
  538. * (optional) An associative array of variables within $_SERVER that should
  539. * be replaced. If the special element 'url' is provided in this array, it
  540. * will be used to populate some of the server defaults; it should be set to
  541. * the URL of the current page request, excluding any $_GET request but
  542. * including the script name (e.g., http://www.example.com/mysite/index.php).
  543. *
  544. * @see conf_path()
  545. * @see request_uri()
  546. * @see ip_address()
  547. */
  548. function drupal_override_server_variables($variables = array()) {
  549. // Allow the provided URL to override any existing values in $_SERVER.
  550. if (isset($variables['url'])) {
  551. $url = parse_url($variables['url']);
  552. if (isset($url['host'])) {
  553. $_SERVER['HTTP_HOST'] = $url['host'];
  554. }
  555. if (isset($url['path'])) {
  556. $_SERVER['SCRIPT_NAME'] = $url['path'];
  557. }
  558. unset($variables['url']);
  559. }
  560. // Define default values for $_SERVER keys. These will be used if $_SERVER
  561. // does not already define them and no other values are passed in to this
  562. // function.
  563. $defaults = array(
  564. 'HTTP_HOST' => 'localhost',
  565. 'SCRIPT_NAME' => NULL,
  566. 'REMOTE_ADDR' => '127.0.0.1',
  567. 'REQUEST_METHOD' => 'GET',
  568. 'SERVER_NAME' => NULL,
  569. 'SERVER_SOFTWARE' => NULL,
  570. 'HTTP_USER_AGENT' => NULL,
  571. );
  572. // Replace elements of the $_SERVER array, as appropriate.
  573. $_SERVER = $variables + $_SERVER + $defaults;
  574. }
  575. /**
  576. * Initializes the PHP environment.
  577. */
  578. function drupal_environment_initialize() {
  579. if (!isset($_SERVER['HTTP_REFERER'])) {
  580. $_SERVER['HTTP_REFERER'] = '';
  581. }
  582. if (!isset($_SERVER['SERVER_PROTOCOL']) || ($_SERVER['SERVER_PROTOCOL'] != 'HTTP/1.0' && $_SERVER['SERVER_PROTOCOL'] != 'HTTP/1.1')) {
  583. $_SERVER['SERVER_PROTOCOL'] = 'HTTP/1.0';
  584. }
  585. if (isset($_SERVER['HTTP_HOST'])) {
  586. // As HTTP_HOST is user input, ensure it only contains characters allowed
  587. // in hostnames. See RFC 952 (and RFC 2181).
  588. // $_SERVER['HTTP_HOST'] is lowercased here per specifications.
  589. $_SERVER['HTTP_HOST'] = strtolower($_SERVER['HTTP_HOST']);
  590. if (!drupal_valid_http_host($_SERVER['HTTP_HOST'])) {
  591. // HTTP_HOST is invalid, e.g. if containing slashes it may be an attack.
  592. header($_SERVER['SERVER_PROTOCOL'] . ' 400 Bad Request');
  593. exit;
  594. }
  595. }
  596. else {
  597. // Some pre-HTTP/1.1 clients will not send a Host header. Ensure the key is
  598. // defined for E_ALL compliance.
  599. $_SERVER['HTTP_HOST'] = '';
  600. }
  601. // When clean URLs are enabled, emulate ?q=foo/bar using REQUEST_URI. It is
  602. // not possible to append the query string using mod_rewrite without the B
  603. // flag (this was added in Apache 2.2.8), because mod_rewrite unescapes the
  604. // path before passing it on to PHP. This is a problem when the path contains
  605. // e.g. "&" or "%" that have special meanings in URLs and must be encoded.
  606. $_GET['q'] = request_path();
  607. // Enforce E_ALL, but allow users to set levels not part of E_ALL.
  608. error_reporting(E_ALL | error_reporting());
  609. // Override PHP settings required for Drupal to work properly.
  610. // sites/default/default.settings.php contains more runtime settings.
  611. // The .htaccess file contains settings that cannot be changed at runtime.
  612. // Don't escape quotes when reading files from the database, disk, etc.
  613. ini_set('magic_quotes_runtime', '0');
  614. // Use session cookies, not transparent sessions that puts the session id in
  615. // the query string.
  616. ini_set('session.use_cookies', '1');
  617. ini_set('session.use_only_cookies', '1');
  618. ini_set('session.use_trans_sid', '0');
  619. // Don't send HTTP headers using PHP's session handler.
  620. // An empty string is used here to disable the cache limiter.
  621. ini_set('session.cache_limiter', '');
  622. // Use httponly session cookies.
  623. ini_set('session.cookie_httponly', '1');
  624. // Set sane locale settings, to ensure consistent string, dates, times and
  625. // numbers handling.
  626. setlocale(LC_ALL, 'C');
  627. // PHP's built-in phar:// stream wrapper is not sufficiently secure. Override
  628. // it with a more secure one, which requires PHP 5.3.3. For lower versions,
  629. // unregister the built-in one without replacing it. Sites needing phar
  630. // support for lower PHP versions must implement hook_stream_wrappers() to
  631. // register their desired implementation.
  632. if (in_array('phar', stream_get_wrappers(), TRUE)) {
  633. stream_wrapper_unregister('phar');
  634. if (version_compare(PHP_VERSION, '5.3.3', '>=')) {
  635. include_once DRUPAL_ROOT . '/includes/file.phar.inc';
  636. file_register_phar_wrapper();
  637. }
  638. }
  639. }
  640. /**
  641. * Validates that a hostname (for example $_SERVER['HTTP_HOST']) is safe.
  642. *
  643. * @return
  644. * TRUE if only containing valid characters, or FALSE otherwise.
  645. */
  646. function drupal_valid_http_host($host) {
  647. // Limit the length of the host name to 1000 bytes to prevent DoS attacks with
  648. // long host names.
  649. return strlen($host) <= 1000
  650. // Limit the number of subdomains and port separators to prevent DoS attacks
  651. // in conf_path().
  652. && substr_count($host, '.') <= 100
  653. && substr_count($host, ':') <= 100
  654. && preg_match('/^\[?(?:[a-zA-Z0-9-:\]_]+\.?)+$/', $host);
  655. }
  656. /**
  657. * Checks whether an HTTPS request is being served.
  658. *
  659. * @return bool
  660. * TRUE if the request is HTTPS, FALSE otherwise.
  661. */
  662. function drupal_is_https() {
  663. return isset($_SERVER['HTTPS']) && strtolower($_SERVER['HTTPS']) == 'on';
  664. }
  665. /**
  666. * Sets the base URL, cookie domain, and session name from configuration.
  667. */
  668. function drupal_settings_initialize() {
  669. global $base_url, $base_path, $base_root;
  670. // Export these settings.php variables to the global namespace.
  671. global $databases, $cookie_domain, $conf, $installed_profile, $update_free_access, $db_url, $db_prefix, $drupal_hash_salt, $is_https, $base_secure_url, $base_insecure_url;
  672. $conf = array();
  673. if (file_exists(DRUPAL_ROOT . '/' . conf_path() . '/settings.php')) {
  674. include_once DRUPAL_ROOT . '/' . conf_path() . '/settings.php';
  675. }
  676. $is_https = drupal_is_https();
  677. if (isset($base_url)) {
  678. // Parse fixed base URL from settings.php.
  679. $parts = parse_url($base_url);
  680. if (!isset($parts['path'])) {
  681. $parts['path'] = '';
  682. }
  683. $base_path = $parts['path'] . '/';
  684. // Build $base_root (everything until first slash after "scheme://").
  685. $base_root = substr($base_url, 0, strlen($base_url) - strlen($parts['path']));
  686. }
  687. else {
  688. // Create base URL.
  689. $http_protocol = $is_https ? 'https' : 'http';
  690. $base_root = $http_protocol . '://' . $_SERVER['HTTP_HOST'];
  691. $base_url = $base_root;
  692. // $_SERVER['SCRIPT_NAME'] can, in contrast to $_SERVER['PHP_SELF'], not
  693. // be modified by a visitor.
  694. if ($dir = rtrim(dirname($_SERVER['SCRIPT_NAME']), '\/')) {
  695. $base_path = $dir;
  696. $base_url .= $base_path;
  697. $base_path .= '/';
  698. }
  699. else {
  700. $base_path = '/';
  701. }
  702. }
  703. $base_secure_url = str_replace('http://', 'https://', $base_url);
  704. $base_insecure_url = str_replace('https://', 'http://', $base_url);
  705. if ($cookie_domain) {
  706. // If the user specifies the cookie domain, also use it for session name.
  707. $session_name = $cookie_domain;
  708. }
  709. else {
  710. // Otherwise use $base_url as session name, without the protocol
  711. // to use the same session identifiers across HTTP and HTTPS.
  712. list( , $session_name) = explode('://', $base_url, 2);
  713. // HTTP_HOST can be modified by a visitor, but we already sanitized it
  714. // in drupal_settings_initialize().
  715. if (!empty($_SERVER['HTTP_HOST'])) {
  716. $cookie_domain = $_SERVER['HTTP_HOST'];
  717. // Strip leading periods, www., and port numbers from cookie domain.
  718. $cookie_domain = ltrim($cookie_domain, '.');
  719. if (strpos($cookie_domain, 'www.') === 0) {
  720. $cookie_domain = substr($cookie_domain, 4);
  721. }
  722. $cookie_domain = explode(':', $cookie_domain);
  723. $cookie_domain = '.' . $cookie_domain[0];
  724. }
  725. }
  726. // Per RFC 2109, cookie domains must contain at least one dot other than the
  727. // first. For hosts such as 'localhost' or IP Addresses we don't set a cookie domain.
  728. if (count(explode('.', $cookie_domain)) > 2 && !is_numeric(str_replace('.', '', $cookie_domain))) {
  729. ini_set('session.cookie_domain', $cookie_domain);
  730. }
  731. // To prevent session cookies from being hijacked, a user can configure the
  732. // SSL version of their website to only transfer session cookies via SSL by
  733. // using PHP's session.cookie_secure setting. The browser will then use two
  734. // separate session cookies for the HTTPS and HTTP versions of the site. So we
  735. // must use different session identifiers for HTTPS and HTTP to prevent a
  736. // cookie collision.
  737. if ($is_https) {
  738. ini_set('session.cookie_secure', TRUE);
  739. }
  740. $prefix = ini_get('session.cookie_secure') ? 'SSESS' : 'SESS';
  741. session_name($prefix . substr(hash('sha256', $session_name), 0, 32));
  742. }
  743. /**
  744. * Returns and optionally sets the filename for a system resource.
  745. *
  746. * The filename, whether provided, cached, or retrieved from the database, is
  747. * only returned if the file exists.
  748. *
  749. * This function plays a key role in allowing Drupal's resources (modules
  750. * and themes) to be located in different places depending on a site's
  751. * configuration. For example, a module 'foo' may legally be located
  752. * in any of these three places:
  753. *
  754. * modules/foo/foo.module
  755. * sites/all/modules/foo/foo.module
  756. * sites/example.com/modules/foo/foo.module
  757. *
  758. * Calling drupal_get_filename('module', 'foo') will give you one of
  759. * the above, depending on where the module is located.
  760. *
  761. * @param $type
  762. * The type of the item (theme, theme_engine, module, profile).
  763. * @param $name
  764. * The name of the item for which the filename is requested.
  765. * @param $filename
  766. * The filename of the item if it is to be set explicitly rather
  767. * than by consulting the database.
  768. * @param bool $trigger_error
  769. * Whether to trigger an error when a file is missing or has unexpectedly
  770. * moved. This defaults to TRUE, but can be set to FALSE by calling code that
  771. * merely wants to check whether an item exists in the filesystem.
  772. *
  773. * @return
  774. * The filename of the requested item or NULL if the item is not found.
  775. */
  776. function drupal_get_filename($type, $name, $filename = NULL, $trigger_error = TRUE) {
  777. // The $files static variable will hold the locations of all requested files.
  778. // We can be sure that any file listed in this static variable actually
  779. // exists as all additions have gone through a file_exists() check.
  780. // The location of files will not change during the request, so do not use
  781. // drupal_static().
  782. static $files = array();
  783. // Profiles are a special case: they have a fixed location and naming.
  784. if ($type == 'profile') {
  785. $profile_filename = "profiles/$name/$name.profile";
  786. $files[$type][$name] = file_exists($profile_filename) ? $profile_filename : FALSE;
  787. }
  788. if (!isset($files[$type])) {
  789. $files[$type] = array();
  790. }
  791. if (!empty($filename) && file_exists($filename)) {
  792. // Prime the static cache with the provided filename.
  793. $files[$type][$name] = $filename;
  794. }
  795. elseif (isset($files[$type][$name])) {
  796. // This item had already been found earlier in the request, either through
  797. // priming of the static cache (for example, in system_list()), through a
  798. // lookup in the {system} table, or through a file scan (cached or not). Do
  799. // nothing.
  800. }
  801. else {
  802. // Look for the filename listed in the {system} table. Verify that we have
  803. // an active database connection before doing so, since this function is
  804. // called both before we have a database connection (i.e. during
  805. // installation) and when a database connection fails.
  806. $database_unavailable = TRUE;
  807. try {
  808. if (function_exists('db_query')) {
  809. $file = db_query("SELECT filename FROM {system} WHERE name = :name AND type = :type", array(':name' => $name, ':type' => $type))->fetchField();
  810. if ($file !== FALSE && file_exists(DRUPAL_ROOT . '/' . $file)) {
  811. $files[$type][$name] = $file;
  812. }
  813. $database_unavailable = FALSE;
  814. }
  815. }
  816. catch (Exception $e) {
  817. // The database table may not exist because Drupal is not yet installed,
  818. // the database might be down, or we may have done a non-database cache
  819. // flush while $conf['page_cache_without_database'] = TRUE and
  820. // $conf['page_cache_invoke_hooks'] = TRUE. We have a fallback for these
  821. // cases so we hide the error completely.
  822. }
  823. // Fall back to searching the filesystem if the database could not find the
  824. // file or the file does not exist at the path returned by the database.
  825. if (!isset($files[$type][$name])) {
  826. $files[$type][$name] = _drupal_get_filename_fallback($type, $name, $trigger_error, $database_unavailable);
  827. }
  828. }
  829. if (isset($files[$type][$name])) {
  830. return $files[$type][$name];
  831. }
  832. }
  833. /**
  834. * Performs a cached file system scan as a fallback when searching for a file.
  835. *
  836. * This function looks for the requested file by triggering a file scan,
  837. * caching the new location if the file has moved and caching the miss
  838. * if the file is missing. If a file had been marked as missing in a previous
  839. * file scan, or if it has been marked as moved and is still in the last known
  840. * location, no new file scan will be performed.
  841. *
  842. * @param string $type
  843. * The type of the item (theme, theme_engine, module, profile).
  844. * @param string $name
  845. * The name of the item for which the filename is requested.
  846. * @param bool $trigger_error
  847. * Whether to trigger an error when a file is missing or has unexpectedly
  848. * moved.
  849. * @param bool $database_unavailable
  850. * Whether this function is being called because the Drupal database could
  851. * not be queried for the file's location.
  852. *
  853. * @return
  854. * The filename of the requested item or NULL if the item is not found.
  855. *
  856. * @see drupal_get_filename()
  857. */
  858. function _drupal_get_filename_fallback($type, $name, $trigger_error, $database_unavailable) {
  859. $file_scans = &_drupal_file_scan_cache();
  860. $filename = NULL;
  861. // If the cache indicates that the item is missing, or we can verify that the
  862. // item exists in the location the cache says it exists in, use that.
  863. if (isset($file_scans[$type][$name]) && ($file_scans[$type][$name] === FALSE || file_exists($file_scans[$type][$name]))) {
  864. $filename = $file_scans[$type][$name];
  865. }
  866. // Otherwise, perform a new file scan to find the item.
  867. else {
  868. $filename = _drupal_get_filename_perform_file_scan($type, $name);
  869. // Update the static cache, and mark the persistent cache for updating at
  870. // the end of the page request. See drupal_file_scan_write_cache().
  871. $file_scans[$type][$name] = $filename;
  872. $file_scans['#write_cache'] = TRUE;
  873. }
  874. // If requested, trigger a user-level warning about the missing or
  875. // unexpectedly moved file. If the database was unavailable, do not trigger a
  876. // warning in the latter case, though, since if the {system} table could not
  877. // be queried there is no way to know if the location found here was
  878. // "unexpected" or not.
  879. if ($trigger_error) {
  880. $error_type = $filename === FALSE ? 'missing' : 'moved';
  881. if ($error_type == 'missing' || !$database_unavailable) {
  882. _drupal_get_filename_fallback_trigger_error($type, $name, $error_type);
  883. }
  884. }
  885. // The cache stores FALSE for files that aren't found (to be able to
  886. // distinguish them from files that have not yet been searched for), but
  887. // drupal_get_filename() expects NULL for these instead, so convert to NULL
  888. // before returning.
  889. if ($filename === FALSE) {
  890. $filename = NULL;
  891. }
  892. return $filename;
  893. }
  894. /**
  895. * Returns the current list of cached file system scan results.
  896. *
  897. * @return
  898. * An associative array tracking the most recent file scan results for all
  899. * files that have had scans performed. The keys are the type and name of the
  900. * item that was searched for, and the values can be either:
  901. * - Boolean FALSE if the item was not found in the file system.
  902. * - A string pointing to the location where the item was found.
  903. */
  904. function &_drupal_file_scan_cache() {
  905. $file_scans = &drupal_static(__FUNCTION__, array());
  906. // The file scan results are stored in a persistent cache (in addition to the
  907. // static cache) but because this function can be called before the
  908. // persistent cache is available, we must merge any items that were found
  909. // earlier in the page request into the results from the persistent cache.
  910. if (!isset($file_scans['#cache_merge_done'])) {
  911. try {
  912. if (function_exists('cache_get')) {
  913. $cache = cache_get('_drupal_file_scan_cache', 'cache_bootstrap');
  914. if (!empty($cache->data)) {
  915. // File scan results from the current request should take precedence
  916. // over the results from the persistent cache, since they are newer.
  917. $file_scans = drupal_array_merge_deep($cache->data, $file_scans);
  918. }
  919. // Set a flag to indicate that the persistent cache does not need to be
  920. // merged again.
  921. $file_scans['#cache_merge_done'] = TRUE;
  922. }
  923. }
  924. catch (Exception $e) {
  925. // Hide the error.
  926. }
  927. }
  928. return $file_scans;
  929. }
  930. /**
  931. * Performs a file system scan to search for a system resource.
  932. *
  933. * @param $type
  934. * The type of the item (theme, theme_engine, module, profile).
  935. * @param $name
  936. * The name of the item for which the filename is requested.
  937. *
  938. * @return
  939. * The filename of the requested item or FALSE if the item is not found.
  940. *
  941. * @see drupal_get_filename()
  942. * @see _drupal_get_filename_fallback()
  943. */
  944. function _drupal_get_filename_perform_file_scan($type, $name) {
  945. // The location of files will not change during the request, so do not use
  946. // drupal_static().
  947. static $dirs = array(), $files = array();
  948. // We have a consistent directory naming: modules, themes...
  949. $dir = $type . 's';
  950. if ($type == 'theme_engine') {
  951. $dir = 'themes/engines';
  952. $extension = 'engine';
  953. }
  954. elseif ($type == 'theme') {
  955. $extension = 'info';
  956. }
  957. else {
  958. $extension = $type;
  959. }
  960. // Check if we had already scanned this directory/extension combination.
  961. if (!isset($dirs[$dir][$extension])) {
  962. // Log that we have now scanned this directory/extension combination
  963. // into a static variable so as to prevent unnecessary file scans.
  964. $dirs[$dir][$extension] = TRUE;
  965. if (!function_exists('drupal_system_listing')) {
  966. require_once DRUPAL_ROOT . '/includes/common.inc';
  967. }
  968. // Scan the appropriate directories for all files with the requested
  969. // extension, not just the file we are currently looking for. This
  970. // prevents unnecessary scans from being repeated when this function is
  971. // called more than once in the same page request.
  972. $matches = drupal_system_listing("/^" . DRUPAL_PHP_FUNCTION_PATTERN . "\.$extension$/", $dir, 'name', 0);
  973. foreach ($matches as $matched_name => $file) {
  974. // Log the locations found in the file scan into a static variable.
  975. $files[$type][$matched_name] = $file->uri;
  976. }
  977. }
  978. // Return the results of the file system scan, or FALSE to indicate the file
  979. // was not found.
  980. return isset($files[$type][$name]) ? $files[$type][$name] : FALSE;
  981. }
  982. /**
  983. * Triggers a user-level warning for missing or unexpectedly moved files.
  984. *
  985. * @param $type
  986. * The type of the item (theme, theme_engine, module, profile).
  987. * @param $name
  988. * The name of the item for which the filename is requested.
  989. * @param $error_type
  990. * The type of the error ('missing' or 'moved').
  991. *
  992. * @see drupal_get_filename()
  993. * @see _drupal_get_filename_fallback()
  994. */
  995. function _drupal_get_filename_fallback_trigger_error($type, $name, $error_type) {
  996. // Hide messages due to known bugs that will appear on a lot of sites.
  997. // @todo Remove this in https://www.drupal.org/node/2383823
  998. if (empty($name)) {
  999. return;
  1000. }
  1001. // Make sure we only show any missing or moved file errors only once per
  1002. // request.
  1003. static $errors_triggered = array();
  1004. if (empty($errors_triggered[$type][$name][$error_type])) {
  1005. // Use _drupal_trigger_error_with_delayed_logging() here since these are
  1006. // triggered during low-level operations that cannot necessarily be
  1007. // interrupted by a watchdog() call.
  1008. if ($error_type == 'missing') {
  1009. _drupal_trigger_error_with_delayed_logging(format_string('The following @type is missing from the file system: %name. For information about how to fix this, see <a href="@documentation">the documentation page</a>.', array('@type' => $type, '%name' => $name, '@documentation' => 'https://www.drupal.org/node/2487215')), E_USER_WARNING);
  1010. }
  1011. elseif ($error_type == 'moved') {
  1012. _drupal_trigger_error_with_delayed_logging(format_string('The following @type has moved within the file system: %name. In order to fix this, clear caches or put the @type back in its original location. For more information, see <a href="@documentation">the documentation page</a>.', array('@type' => $type, '%name' => $name, '@documentation' => 'https://www.drupal.org/node/2487215')), E_USER_WARNING);
  1013. }
  1014. $errors_triggered[$type][$name][$error_type] = TRUE;
  1015. }
  1016. }
  1017. /**
  1018. * Invokes trigger_error() with logging delayed until the end of the request.
  1019. *
  1020. * This is an alternative to PHP's trigger_error() function which can be used
  1021. * during low-level Drupal core operations that need to avoid being interrupted
  1022. * by a watchdog() call.
  1023. *
  1024. * Normally, Drupal's error handler calls watchdog() in response to a
  1025. * trigger_error() call. However, this invokes hook_watchdog() which can run
  1026. * arbitrary code. If the trigger_error() happens in the middle of an
  1027. * operation such as a rebuild operation which should not be interrupted by
  1028. * arbitrary code, that could potentially break or trigger the rebuild again.
  1029. * This function protects against that by delaying the watchdog() call until
  1030. * the end of the current page request.
  1031. *
  1032. * This is an internal function which should only be called by low-level Drupal
  1033. * core functions. It may be removed in a future Drupal 7 release.
  1034. *
  1035. * @param string $error_msg
  1036. * The error message to trigger. As with trigger_error() itself, this is
  1037. * limited to 1024 bytes; additional characters beyond that will be removed.
  1038. * @param int $error_type
  1039. * (optional) The type of error. This should be one of the E_USER family of
  1040. * constants. As with trigger_error() itself, this defaults to E_USER_NOTICE
  1041. * if not provided.
  1042. *
  1043. * @see _drupal_log_error()
  1044. */
  1045. function _drupal_trigger_error_with_delayed_logging($error_msg, $error_type = E_USER_NOTICE) {
  1046. $delay_logging = &drupal_static(__FUNCTION__, FALSE);
  1047. $delay_logging = TRUE;
  1048. trigger_error($error_msg, $error_type);
  1049. $delay_logging = FALSE;
  1050. }
  1051. /**
  1052. * Writes the file scan cache to the persistent cache.
  1053. *
  1054. * This cache stores all files marked as missing or moved after a file scan
  1055. * to prevent unnecessary file scans in subsequent requests. This cache is
  1056. * cleared in system_list_reset() (i.e. after a module/theme rebuild).
  1057. */
  1058. function drupal_file_scan_write_cache() {
  1059. // Only write to the persistent cache if requested, and if we know that any
  1060. // data previously in the cache was successfully loaded and merged in by
  1061. // _drupal_file_scan_cache().
  1062. $file_scans = &_drupal_file_scan_cache();
  1063. if (isset($file_scans['#write_cache']) && isset($file_scans['#cache_merge_done'])) {
  1064. unset($file_scans['#write_cache']);
  1065. cache_set('_drupal_file_scan_cache', $file_scans, 'cache_bootstrap');
  1066. }
  1067. }
  1068. /**
  1069. * Loads the persistent variable table.
  1070. *
  1071. * The variable table is composed of values that have been saved in the table
  1072. * with variable_set() as well as those explicitly specified in the
  1073. * configuration file.
  1074. */
  1075. function variable_initialize($conf = array()) {
  1076. // NOTE: caching the variables improves performance by 20% when serving
  1077. // cached pages.
  1078. if ($cached = cache_get('variables', 'cache_bootstrap')) {
  1079. $variables = $cached->data;
  1080. }
  1081. else {
  1082. // Cache miss. Avoid a stampede.
  1083. $name = 'variable_init';
  1084. if (!lock_acquire($name, 1)) {
  1085. // Another request is building the variable cache.
  1086. // Wait, then re-run this function.
  1087. lock_wait($name);
  1088. return variable_initialize($conf);
  1089. }
  1090. else {
  1091. // Proceed with variable rebuild.
  1092. $variables = array_map('unserialize', db_query('SELECT name, value FROM {variable}')->fetchAllKeyed());
  1093. cache_set('variables', $variables, 'cache_bootstrap');
  1094. lock_release($name);
  1095. }
  1096. }
  1097. foreach ($conf as $name => $value) {
  1098. $variables[$name] = $value;
  1099. }
  1100. return $variables;
  1101. }
  1102. /**
  1103. * Returns a persistent variable.
  1104. *
  1105. * Case-sensitivity of the variable_* functions depends on the database
  1106. * collation used. To avoid problems, always use lower case for persistent
  1107. * variable names.
  1108. *
  1109. * @param $name
  1110. * The name of the variable to return.
  1111. * @param $default
  1112. * The default value to use if this variable has never been set.
  1113. *
  1114. * @return
  1115. * The value of the variable. Unserialization is taken care of as necessary.
  1116. *
  1117. * @see variable_del()
  1118. * @see variable_set()
  1119. */
  1120. function variable_get($name, $default = NULL) {
  1121. global $conf;
  1122. return isset($conf[$name]) ? $conf[$name] : $default;
  1123. }
  1124. /**
  1125. * Sets a persistent variable.
  1126. *
  1127. * Case-sensitivity of the variable_* functions depends on the database
  1128. * collation used. To avoid problems, always use lower case for persistent
  1129. * variable names.
  1130. *
  1131. * @param $name
  1132. * The name of the variable to set.
  1133. * @param $value
  1134. * The value to set. This can be any PHP data type; these functions take care
  1135. * of serialization as necessary.
  1136. *
  1137. * @see variable_del()
  1138. * @see variable_get()
  1139. */
  1140. function variable_set($name, $value) {
  1141. global $conf;
  1142. db_merge('variable')->key(array('name' => $name))->fields(array('value' => serialize($value)))->execute();
  1143. cache_clear_all('variables', 'cache_bootstrap');
  1144. $conf[$name] = $value;
  1145. }
  1146. /**
  1147. * Unsets a persistent variable.
  1148. *
  1149. * Case-sensitivity of the variable_* functions depends on the database
  1150. * collation used. To avoid problems, always use lower case for persistent
  1151. * variable names.
  1152. *
  1153. * @param $name
  1154. * The name of the variable to undefine.
  1155. *
  1156. * @see variable_get()
  1157. * @see variable_set()
  1158. */
  1159. function variable_del($name) {
  1160. global $conf;
  1161. db_delete('variable')
  1162. ->condition('name', $name)
  1163. ->execute();
  1164. cache_clear_all('variables', 'cache_bootstrap');
  1165. unset($conf[$name]);
  1166. }
  1167. /**
  1168. * Retrieves the current page from the cache.
  1169. *
  1170. * Note: we do not serve cached pages to authenticated users, or to anonymous
  1171. * users when $_SESSION is non-empty. $_SESSION may contain status messages
  1172. * from a form submission, the contents of a shopping cart, or other user-
  1173. * specific content that should not be cached and displayed to other users.
  1174. *
  1175. * @param $check_only
  1176. * (optional) Set to TRUE to only return whether a previous call found a
  1177. * cache entry.
  1178. *
  1179. * @return
  1180. * The cache object, if the page was found in the cache, NULL otherwise.
  1181. */
  1182. function drupal_page_get_cache($check_only = FALSE) {
  1183. global $base_root;
  1184. static $cache_hit = FALSE;
  1185. if ($check_only) {
  1186. return $cache_hit;
  1187. }
  1188. if (drupal_page_is_cacheable()) {
  1189. $cache = cache_get($base_root . request_uri(), 'cache_page');
  1190. if ($cache !== FALSE) {
  1191. $cache_hit = TRUE;
  1192. }
  1193. return $cache;
  1194. }
  1195. }
  1196. /**
  1197. * Determines the cacheability of the current page.
  1198. *
  1199. * @param $allow_caching
  1200. * Set to FALSE if you want to prevent this page from being cached.
  1201. *
  1202. * @return
  1203. * TRUE if the current page can be cached, FALSE otherwise.
  1204. */
  1205. function drupal_page_is_cacheable($allow_caching = NULL) {
  1206. $allow_caching_static = &drupal_static(__FUNCTION__, TRUE);
  1207. if (isset($allow_caching)) {
  1208. $allow_caching_static = $allow_caching;
  1209. }
  1210. return $allow_caching_static && ($_SERVER['REQUEST_METHOD'] == 'GET' || $_SERVER['REQUEST_METHOD'] == 'HEAD')
  1211. && !drupal_is_cli();
  1212. }
  1213. /**
  1214. * Invokes a bootstrap hook in all bootstrap modules that implement it.
  1215. *
  1216. * @param $hook
  1217. * The name of the bootstrap hook to invoke.
  1218. *
  1219. * @see bootstrap_hooks()
  1220. */
  1221. function bootstrap_invoke_all($hook) {
  1222. // Bootstrap modules should have been loaded when this function is called, so
  1223. // we don't need to tell module_list() to reset its internal list (and we
  1224. // therefore leave the first parameter at its default value of FALSE). We
  1225. // still pass in TRUE for the second parameter, though; in case this is the
  1226. // first time during the bootstrap that module_list() is called, we want to
  1227. // make sure that its internal cache is primed with the bootstrap modules
  1228. // only.
  1229. foreach (module_list(FALSE, TRUE) as $module) {
  1230. drupal_load('module', $module);
  1231. module_invoke($module, $hook);
  1232. }
  1233. }
  1234. /**
  1235. * Includes a file with the provided type and name.
  1236. *
  1237. * This prevents including a theme, engine, module, etc., more than once.
  1238. *
  1239. * @param $type
  1240. * The type of item to load (i.e. theme, theme_engine, module).
  1241. * @param $name
  1242. * The name of the item to load.
  1243. *
  1244. * @return
  1245. * TRUE if the item is loaded or has already been loaded.
  1246. */
  1247. function drupal_load($type, $name) {
  1248. // Once a file is included this can't be reversed during a request so do not
  1249. // use drupal_static() here.
  1250. static $files = array();
  1251. if (isset($files[$type][$name])) {
  1252. return TRUE;
  1253. }
  1254. $filename = drupal_get_filename($type, $name);
  1255. if ($filename) {
  1256. include_once DRUPAL_ROOT . '/' . $filename;
  1257. $files[$type][$name] = TRUE;
  1258. return TRUE;
  1259. }
  1260. return FALSE;
  1261. }
  1262. /**
  1263. * Sets an HTTP response header for the current page.
  1264. *
  1265. * Note: When sending a Content-Type header, always include a 'charset' type,
  1266. * too. This is necessary to avoid security bugs (e.g. UTF-7 XSS).
  1267. *
  1268. * @param $name
  1269. * The HTTP header name, or the special 'Status' header name.
  1270. * @param $value
  1271. * The HTTP header value; if equal to FALSE, the specified header is unset.
  1272. * If $name is 'Status', this is expected to be a status code followed by a
  1273. * reason phrase, e.g. "404 Not Found".
  1274. * @param $append
  1275. * Whether to append the value to an existing header or to replace it.
  1276. */
  1277. function drupal_add_http_header($name, $value, $append = FALSE) {
  1278. // The headers as name/value pairs.
  1279. $headers = &drupal_static('drupal_http_headers', array());
  1280. $name_lower = strtolower($name);
  1281. _drupal_set_preferred_header_name($name);
  1282. if ($value === FALSE) {
  1283. $headers[$name_lower] = FALSE;
  1284. }
  1285. elseif (isset($headers[$name_lower]) && $append) {
  1286. // Multiple headers with identical names may be combined using comma (RFC
  1287. // 2616, section 4.2).
  1288. $headers[$name_lower] .= ',' . $value;
  1289. }
  1290. else {
  1291. $headers[$name_lower] = $value;
  1292. }
  1293. drupal_send_headers(array($name => $headers[$name_lower]), TRUE);
  1294. }
  1295. /**
  1296. * Gets the HTTP response headers for the current page.
  1297. *
  1298. * @param $name
  1299. * An HTTP header name. If omitted, all headers are returned as name/value
  1300. * pairs. If an array value is FALSE, the header has been unset.
  1301. *
  1302. * @return
  1303. * A string containing the header value, or FALSE if the header has been set,
  1304. * or NULL if the header has not been set.
  1305. */
  1306. function drupal_get_http_header($name = NULL) {
  1307. $headers = &drupal_static('drupal_http_headers', array());
  1308. if (isset($name)) {
  1309. $name = strtolower($name);
  1310. return isset($headers[$name]) ? $headers[$name] : NULL;
  1311. }
  1312. else {
  1313. return $headers;
  1314. }
  1315. }
  1316. /**
  1317. * Sets the preferred name for the HTTP header.
  1318. *
  1319. * Header names are case-insensitive, but for maximum compatibility they should
  1320. * follow "common form" (see RFC 2617, section 4.2).
  1321. */
  1322. function _drupal_set_preferred_header_name($name = NULL) {
  1323. static $header_names = array();
  1324. if (!isset($name)) {
  1325. return $header_names;
  1326. }
  1327. $header_names[strtolower($name)] = $name;
  1328. }
  1329. /**
  1330. * Sends the HTTP response headers that were previously set, adding defaults.
  1331. *
  1332. * Headers are set in drupal_add_http_header(). Default headers are not set
  1333. * if they have been replaced or unset using drupal_add_http_header().
  1334. *
  1335. * @param array $default_headers
  1336. * (optional) An array of headers as name/value pairs.
  1337. * @param bool $only_default
  1338. * (optional) If TRUE and headers have already been sent, send only the
  1339. * specified headers.
  1340. */
  1341. function drupal_send_headers($default_headers = array(), $only_default = FALSE) {
  1342. $headers_sent = &drupal_static(__FUNCTION__, FALSE);
  1343. $headers = drupal_get_http_header();
  1344. if ($only_default && $headers_sent) {
  1345. $headers = array();
  1346. }
  1347. $headers_sent = TRUE;
  1348. $header_names = _drupal_set_preferred_header_name();
  1349. foreach ($default_headers as $name => $value) {
  1350. $name_lower = strtolower($name);
  1351. if (!isset($headers[$name_lower])) {
  1352. $headers[$name_lower] = $value;
  1353. $header_names[$name_lower] = $name;
  1354. }
  1355. }
  1356. foreach ($headers as $name_lower => $value) {
  1357. if ($name_lower == 'status') {
  1358. header($_SERVER['SERVER_PROTOCOL'] . ' ' . $value);
  1359. }
  1360. // Skip headers that have been unset.
  1361. elseif ($value !== FALSE) {
  1362. header($header_names[$name_lower] . ': ' . $value);
  1363. }
  1364. }
  1365. }
  1366. /**
  1367. * Sets HTTP headers in preparation for a page response.
  1368. *
  1369. * Authenticated users are always given a 'no-cache' header, and will fetch a
  1370. * fresh page on every request. This prevents authenticated users from seeing
  1371. * locally cached pages.
  1372. *
  1373. * ETag and Last-Modified headers are not set per default for authenticated
  1374. * users so that browsers do not send If-Modified-Since headers from
  1375. * authenticated user pages. drupal_serve_page_from_cache() will set appropriate
  1376. * ETag and Last-Modified headers for cached pages.
  1377. *
  1378. * @see drupal_page_set_cache()
  1379. */
  1380. function drupal_page_header() {
  1381. $headers_sent = &drupal_static(__FUNCTION__, FALSE);
  1382. if ($headers_sent) {
  1383. return TRUE;
  1384. }
  1385. $headers_sent = TRUE;
  1386. $default_headers = array(
  1387. 'Expires' => 'Sun, 19 Nov 1978 05:00:00 GMT',
  1388. 'Cache-Control' => 'no-cache, must-revalidate',
  1389. // Prevent browsers from sniffing a response and picking a MIME type
  1390. // different from the declared content-type, since that can lead to
  1391. // XSS and other vulnerabilities.
  1392. 'X-Content-Type-Options' => 'nosniff',
  1393. );
  1394. drupal_send_headers($default_headers);
  1395. }
  1396. /**
  1397. * Sets HTTP headers in preparation for a cached page response.
  1398. *
  1399. * The headers allow as much as possible in proxies and browsers without any
  1400. * particular knowledge about the pages. Modules can override these headers
  1401. * using drupal_add_http_header().
  1402. *
  1403. * If the request is conditional (using If-Modified-Since and If-None-Match),
  1404. * and the conditions match those currently in the cache, a 304 Not Modified
  1405. * response is sent.
  1406. */
  1407. function drupal_serve_page_from_cache(stdClass $cache) {
  1408. // Negotiate whether to use compression.
  1409. $page_compression = !empty($cache->data['page_compressed']);
  1410. $return_compressed = $page_compression && isset($_SERVER['HTTP_ACCEPT_ENCODING']) && strpos($_SERVER['HTTP_ACCEPT_ENCODING'], 'gzip') !== FALSE;
  1411. // Get headers set in hook_boot(). Keys are lower-case.
  1412. $hook_boot_headers = drupal_get_http_header();
  1413. // Headers generated in this function, that may be replaced or unset using
  1414. // drupal_add_http_headers(). Keys are mixed-case.
  1415. $default_headers = array();
  1416. foreach ($cache->data['headers'] as $name => $value) {
  1417. // In the case of a 304 response, certain headers must be sent, and the
  1418. // remaining may not (see RFC 2616, section 10.3.5). Do not override
  1419. // headers set in hook_boot().
  1420. $name_lower = strtolower($name);
  1421. if (in_array($name_lower, array('content-location', 'expires', 'cache-control', 'vary')) && !isset($hook_boot_headers[$name_lower])) {
  1422. drupal_add_http_header($name, $value);
  1423. unset($cache->data['headers'][$name]);
  1424. }
  1425. }
  1426. // If the client sent a session cookie, a cached copy will only be served
  1427. // to that one particular client due to Vary: Cookie. Thus, do not set
  1428. // max-age > 0, allowing the page to be cached by external proxies, when a
  1429. // session cookie is present unless the Vary header has been replaced or
  1430. // unset in hook_boot().
  1431. $max_age = !isset($_COOKIE[session_name()]) || isset($hook_boot_headers['vary']) ? variable_get('page_cache_maximum_age', 0) : 0;
  1432. $default_headers['Cache-Control'] = 'public, max-age=' . $max_age;
  1433. // Entity tag should change if the output changes.
  1434. $etag = '"' . $cache->created . '-' . intval($return_compressed) . '"';
  1435. header('Etag: ' . $etag);
  1436. // See if the client has provided the required HTTP headers.
  1437. $if_modified_since = isset($_SERVER['HTTP_IF_MODIFIED_SINCE']) ? strtotime($_SERVER['HTTP_IF_MODIFIED_SINCE']) : FALSE;
  1438. $if_none_match = isset($_SERVER['HTTP_IF_NONE_MATCH']) ? stripslashes($_SERVER['HTTP_IF_NONE_MATCH']) : FALSE;
  1439. if ($if_modified_since && $if_none_match
  1440. && $if_none_match == $etag // etag must match
  1441. && $if_modified_since == $cache->created) { // if-modified-since must match
  1442. header($_SERVER['SERVER_PROTOCOL'] . ' 304 Not Modified');
  1443. drupal_send_headers($default_headers);
  1444. return;
  1445. }
  1446. // Send the remaining headers.
  1447. foreach ($cache->data['headers'] as $name => $value) {
  1448. drupal_add_http_header($name, $value);
  1449. }
  1450. $default_headers['Last-Modified'] = gmdate(DATE_RFC7231, $cache->created);
  1451. // HTTP/1.0 proxies does not support the Vary header, so prevent any caching
  1452. // by sending an Expires date in the past. HTTP/1.1 clients ignores the
  1453. // Expires header if a Cache-Control: max-age= directive is specified (see RFC
  1454. // 2616, section 14.9.3).
  1455. $default_headers['Expires'] = 'Sun, 19 Nov 1978 05:00:00 GMT';
  1456. drupal_send_headers($default_headers);
  1457. // Allow HTTP proxies to cache pages for anonymous users without a session
  1458. // cookie. The Vary header is used to indicates the set of request-header
  1459. // fields that fully determines whether a cache is permitted to use the
  1460. // response to reply to a subsequent request for a given URL without
  1461. // revalidation. If a Vary header has been set in hook_boot(), it is assumed
  1462. // that the module knows how to cache the page.
  1463. if (!isset($hook_boot_headers['vary']) && !variable_get('omit_vary_cookie')) {
  1464. header('Vary: Cookie');
  1465. }
  1466. if ($page_compression) {
  1467. header('Vary: Accept-Encoding', FALSE);
  1468. // If page_compression is enabled, the cache contains gzipped data.
  1469. if ($return_compressed) {
  1470. // $cache->data['body'] is already gzip'ed, so make sure
  1471. // zlib.output_compression does not compress it once more.
  1472. ini_set('zlib.output_compression', '0');
  1473. header('Content-Encoding: gzip');
  1474. }
  1475. else {
  1476. // The client does not support compression, so unzip the data in the
  1477. // cache. Strip the gzip header and run uncompress.
  1478. $cache->data['body'] = gzinflate(substr(substr($cache->data['body'], 10), 0, -8));
  1479. }
  1480. }
  1481. // Print the page.
  1482. print $cache->data['body'];
  1483. }
  1484. /**
  1485. * Defines the critical hooks that force modules to always be loaded.
  1486. */
  1487. function bootstrap_hooks() {
  1488. return array('boot', 'exit', 'watchdog', 'language_init');
  1489. }
  1490. /**
  1491. * Unserializes and appends elements from a serialized string.
  1492. *
  1493. * @param $obj
  1494. * The object to which the elements are appended.
  1495. * @param $field
  1496. * The attribute of $obj whose value should be unserialized.
  1497. */
  1498. function drupal_unpack($obj, $field = 'data') {
  1499. if ($obj->$field && $data = unserialize($obj->$field)) {
  1500. foreach ($data as $key => $value) {
  1501. if (!empty($key) && !isset($obj->$key)) {
  1502. $obj->$key = $value;
  1503. }
  1504. }
  1505. }
  1506. return $obj;
  1507. }
  1508. /**
  1509. * Translates a string to the current language or to a given language.
  1510. *
  1511. * The t() function serves two purposes. First, at run-time it translates
  1512. * user-visible text into the appropriate language. Second, various mechanisms
  1513. * that figure out what text needs to be translated work off t() -- the text
  1514. * inside t() calls is added to the database of strings to be translated.
  1515. * These strings are expected to be in English, so the first argument should
  1516. * always be in English. To enable a fully-translatable site, it is important
  1517. * that all human-readable text that will be displayed on the site or sent to
  1518. * a user is passed through the t() function, or a related function. See the
  1519. * @link http://drupal.org/node/322729 Localization API @endlink pages for
  1520. * more information, including recommendations on how to break up or not
  1521. * break up strings for translation.
  1522. *
  1523. * @section sec_translating_vars Translating Variables
  1524. * You should never use t() to translate variables, such as calling
  1525. * @code t($text); @endcode, unless the text that the variable holds has been
  1526. * passed through t() elsewhere (e.g., $text is one of several translated
  1527. * literal strings in an array). It is especially important never to call
  1528. * @code t($user_text); @endcode, where $user_text is some text that a user
  1529. * entered - doing that can lead to cross-site scripting and other security
  1530. * problems. However, you can use variable substitution in your string, to put
  1531. * variable text such as user names or link URLs into translated text. Variable
  1532. * substitution looks like this:
  1533. * @code
  1534. * $text = t("@name's blog", array('@name' => format_username($account)));
  1535. * @endcode
  1536. * Basically, you can put variables like @name into your string, and t() will
  1537. * substitute their sanitized values at translation time. (See the
  1538. * Localization API pages referenced above and the documentation of
  1539. * format_string() for details about how to define variables in your string.)
  1540. * Translators can then rearrange the string as necessary for the language
  1541. * (e.g., in Spanish, it might be "blog de @name").
  1542. *
  1543. * @section sec_alt_funcs_install Use During Installation Phase
  1544. * During the Drupal installation phase, some resources used by t() wil not be
  1545. * available to code that needs localization. See st() and get_t() for
  1546. * alternatives.
  1547. *
  1548. * @section sec_context String context
  1549. * Matching source strings are normally only translated once, and the same
  1550. * translation is used everywhere that has a matching string. However, in some
  1551. * cases, a certain English source string needs to have multiple translations.
  1552. * One example of this is the string "May", which could be used as either a
  1553. * full month name or a 3-letter abbreviated month. In other languages where
  1554. * the month name for May has more than 3 letters, you would need to provide
  1555. * two different translations (one for the full name and one abbreviated), and
  1556. * the correct form would need to be chosen, depending on how "May" is being
  1557. * used. To facilitate this, the "May" string should be provided with two
  1558. * different contexts in the $options parameter when calling t(). For example:
  1559. * @code
  1560. * t('May', array(), array('context' => 'Long month name')
  1561. * t('May', array(), array('context' => 'Abbreviated month name')
  1562. * @endcode
  1563. * See https://localize.drupal.org/node/2109 for more information.
  1564. *
  1565. * @param $string
  1566. * A string containing the English string to translate.
  1567. * @param $args
  1568. * An associative array of replacements to make after translation. Based
  1569. * on the first character of the key, the value is escaped and/or themed.
  1570. * See format_string() for details.
  1571. * @param $options
  1572. * An associative array of additional options, with the following elements:
  1573. * - 'langcode' (defaults to the current language): The language code to
  1574. * translate to a language other than what is used to display the page.
  1575. * - 'context' (defaults to the empty context): A string giving the context
  1576. * that the source string belongs to. See @ref sec_context above for more
  1577. * information.
  1578. *
  1579. * @return
  1580. * The translated string.
  1581. *
  1582. * @see st()
  1583. * @see get_t()
  1584. * @see format_string()
  1585. * @ingroup sanitization
  1586. */
  1587. function t($string, array $args = array(), array $options = array()) {
  1588. global $language;
  1589. static $custom_strings;
  1590. // Merge in default.
  1591. if (empty($options['langcode'])) {
  1592. $options['langcode'] = isset($language->language) ? $language->language : 'en';
  1593. }
  1594. if (empty($options['context'])) {
  1595. $options['context'] = '';
  1596. }
  1597. // First, check for an array of customized strings. If present, use the array
  1598. // *instead of* database lookups. This is a high performance way to provide a
  1599. // handful of string replacements. See settings.php for examples.
  1600. // Cache the $custom_strings variable to improve performance.
  1601. if (!isset($custom_strings[$options['langcode']])) {
  1602. $custom_strings[$options['langcode']] = variable_get('locale_custom_strings_' . $options['langcode'], array());
  1603. }
  1604. // Custom strings work for English too, even if locale module is disabled.
  1605. if (isset($custom_strings[$options['langcode']][$options['context']][$string])) {
  1606. $string = $custom_strings[$options['langcode']][$options['context']][$string];
  1607. }
  1608. // Translate with locale module if enabled.
  1609. elseif ($options['langcode'] != 'en' && function_exists('locale')) {
  1610. $string = locale($string, $options['context'], $options['langcode']);
  1611. }
  1612. if (empty($args)) {
  1613. return $string;
  1614. }
  1615. else {
  1616. return format_string($string, $args);
  1617. }
  1618. }
  1619. /**
  1620. * Formats a string for HTML display by replacing variable placeholders.
  1621. *
  1622. * This function replaces variable placeholders in a string with the requested
  1623. * values and escapes the values so they can be safely displayed as HTML. It
  1624. * should be used on any unknown text that is intended to be printed to an HTML
  1625. * page (especially text that may have come from untrusted users, since in that
  1626. * case it prevents cross-site scripting and other security problems).
  1627. *
  1628. * In most cases, you should use t() rather than calling this function
  1629. * directly, since it will translate the text (on non-English-only sites) in
  1630. * addition to formatting it.
  1631. *
  1632. * @param $string
  1633. * A string containing placeholders.
  1634. * @param $args
  1635. * An associative array of replacements to make. Occurrences in $string of
  1636. * any key in $args are replaced with the corresponding value, after optional
  1637. * sanitization and formatting. The type of sanitization and formatting
  1638. * depends on the first character of the key:
  1639. * - @variable: Escaped to HTML using check_plain(). Use this as the default
  1640. * choice for anything displayed on a page on the site.
  1641. * - %variable: Escaped to HTML and formatted using drupal_placeholder(),
  1642. * which makes it display as <em>emphasized</em> text.
  1643. * - !variable: Inserted as is, with no sanitization or formatting. Only use
  1644. * this for text that has already been prepared for HTML display (for
  1645. * example, user-supplied text that has already been run through
  1646. * check_plain() previously, or is expected to contain some limited HTML
  1647. * tags and has already been run through filter_xss() previously).
  1648. *
  1649. * @see t()
  1650. * @ingroup sanitization
  1651. */
  1652. function format_string($string, array $args = array()) {
  1653. // Transform arguments before inserting them.
  1654. foreach ($args as $key => $value) {
  1655. switch ($key[0]) {
  1656. case '@':
  1657. // Escaped only.
  1658. $args[$key] = check_plain($value);
  1659. break;
  1660. case '%':
  1661. default:
  1662. // Escaped and placeholder.
  1663. $args[$key] = drupal_placeholder($value);
  1664. break;
  1665. case '!':
  1666. // Pass-through.
  1667. }
  1668. }
  1669. return strtr($string, $args);
  1670. }
  1671. /**
  1672. * Encodes special characters in a plain-text string for display as HTML.
  1673. *
  1674. * Also validates strings as UTF-8 to prevent cross site scripting attacks on
  1675. * Internet Explorer 6.
  1676. *
  1677. * @param string $text
  1678. * The text to be checked or processed.
  1679. *
  1680. * @return string
  1681. * An HTML safe version of $text. If $text is not valid UTF-8, an empty string
  1682. * is returned and, on PHP < 5.4, a warning may be issued depending on server
  1683. * configuration (see @link https://bugs.php.net/bug.php?id=47494 @endlink).
  1684. *
  1685. * @see drupal_validate_utf8()
  1686. * @ingroup sanitization
  1687. */
  1688. function check_plain($text) {
  1689. return htmlspecialchars($text, ENT_QUOTES, 'UTF-8');
  1690. }
  1691. /**
  1692. * Checks whether a string is valid UTF-8.
  1693. *
  1694. * All functions designed to filter input should use drupal_validate_utf8
  1695. * to ensure they operate on valid UTF-8 strings to prevent bypass of the
  1696. * filter.
  1697. *
  1698. * When text containing an invalid UTF-8 lead byte (0xC0 - 0xFF) is presented
  1699. * as UTF-8 to Internet Explorer 6, the program may misinterpret subsequent
  1700. * bytes. When these subsequent bytes are HTML control characters such as
  1701. * quotes or angle brackets, parts of the text that were deemed safe by filters
  1702. * end up in locations that are potentially unsafe; An onerror attribute that
  1703. * is outside of a tag, and thus deemed safe by a filter, can be interpreted
  1704. * by the browser as if it were inside the tag.
  1705. *
  1706. * The function does not return FALSE for strings containing character codes
  1707. * above U+10FFFF, even though these are prohibited by RFC 3629.
  1708. *
  1709. * @param $text
  1710. * The text to check.
  1711. *
  1712. * @return
  1713. * TRUE if the text is valid UTF-8, FALSE if not.
  1714. */
  1715. function drupal_validate_utf8($text) {
  1716. if (strlen($text) == 0) {
  1717. return TRUE;
  1718. }
  1719. // With the PCRE_UTF8 modifier 'u', preg_match() fails silently on strings
  1720. // containing invalid UTF-8 byte sequences. It does not reject character
  1721. // codes above U+10FFFF (represented by 4 or more octets), though.
  1722. return (preg_match('/^./us', $text) == 1);
  1723. }
  1724. /**
  1725. * Returns the equivalent of Apache's $_SERVER['REQUEST_URI'] variable.
  1726. *
  1727. * Because $_SERVER['REQUEST_URI'] is only available on Apache, we generate an
  1728. * equivalent using other environment variables.
  1729. */
  1730. function request_uri() {
  1731. if (isset($_SERVER['REQUEST_URI'])) {
  1732. $uri = $_SERVER['REQUEST_URI'];
  1733. }
  1734. else {
  1735. if (isset($_SERVER['argv'])) {
  1736. $uri = $_SERVER['SCRIPT_NAME'] . '?' . $_SERVER['argv'][0];
  1737. }
  1738. elseif (isset($_SERVER['QUERY_STRING'])) {
  1739. $uri = $_SERVER['SCRIPT_NAME'] . '?' . $_SERVER['QUERY_STRING'];
  1740. }
  1741. else {
  1742. $uri = $_SERVER['SCRIPT_NAME'];
  1743. }
  1744. }
  1745. // Prevent multiple slashes to avoid cross site requests via the Form API.
  1746. $uri = '/' . ltrim($uri, '/');
  1747. return $uri;
  1748. }
  1749. /**
  1750. * Logs an exception.
  1751. *
  1752. * This is a wrapper function for watchdog() which automatically decodes an
  1753. * exception.
  1754. *
  1755. * @param $type
  1756. * The category to which this message belongs.
  1757. * @param $exception
  1758. * The exception that is going to be logged.
  1759. * @param $message
  1760. * The message to store in the log. If empty, a text that contains all useful
  1761. * information about the passed-in exception is used.
  1762. * @param $variables
  1763. * Array of variables to replace in the message on display. Defaults to the
  1764. * return value of _drupal_decode_exception().
  1765. * @param $severity
  1766. * The severity of the message, as per RFC 3164.
  1767. * @param $link
  1768. * A link to associate with the message.
  1769. *
  1770. * @see watchdog()
  1771. * @see _drupal_decode_exception()
  1772. */
  1773. function watchdog_exception($type, Exception $exception, $message = NULL, $variables = array(), $severity = WATCHDOG_ERROR, $link = NULL) {
  1774. // Use a default value if $message is not set.
  1775. if (empty($message)) {
  1776. // The exception message is run through check_plain() by _drupal_decode_exception().
  1777. $message = '%type: !message in %function (line %line of %file).';
  1778. }
  1779. // $variables must be an array so that we can add the exception information.
  1780. if (!is_array($variables)) {
  1781. $variables = array();
  1782. }
  1783. require_once DRUPAL_ROOT . '/includes/errors.inc';
  1784. $variables += _drupal_decode_exception($exception);
  1785. watchdog($type, $message, $variables, $severity, $link);
  1786. }
  1787. /**
  1788. * Logs a system message.
  1789. *
  1790. * @param $type
  1791. * The category to which this message belongs. Can be any string, but the
  1792. * general practice is to use the name of the module calling watchdog().
  1793. * @param $message
  1794. * The message to store in the log. Keep $message translatable
  1795. * by not concatenating dynamic values into it! Variables in the
  1796. * message should be added by using placeholder strings alongside
  1797. * the variables argument to declare the value of the placeholders.
  1798. * See t() for documentation on how $message and $variables interact.
  1799. * @param $variables
  1800. * Array of variables to replace in the message on display or
  1801. * NULL if message is already translated or not possible to
  1802. * translate.
  1803. * @param $severity
  1804. * The severity of the message; one of the following values as defined in
  1805. * @link http://www.faqs.org/rfcs/rfc3164.html RFC 3164: @endlink
  1806. * - WATCHDOG_EMERGENCY: Emergency, system is unusable.
  1807. * - WATCHDOG_ALERT: Alert, action must be taken immediately.
  1808. * - WATCHDOG_CRITICAL: Critical conditions.
  1809. * - WATCHDOG_ERROR: Error conditions.
  1810. * - WATCHDOG_WARNING: Warning conditions.
  1811. * - WATCHDOG_NOTICE: (default) Normal but significant conditions.
  1812. * - WATCHDOG_INFO: Informational messages.
  1813. * - WATCHDOG_DEBUG: Debug-level messages.
  1814. * @param $link
  1815. * A link to associate with the message.
  1816. *
  1817. * @see watchdog_severity_levels()
  1818. * @see hook_watchdog()
  1819. */
  1820. function watchdog($type, $message, $variables = array(), $severity = WATCHDOG_NOTICE, $link = NULL) {
  1821. global $user, $base_root;
  1822. static $in_error_state = FALSE;
  1823. // It is possible that the error handling will itself trigger an error. In that case, we could
  1824. // end up in an infinite loop. To avoid that, we implement a simple static semaphore.
  1825. if (!$in_error_state && function_exists('module_invoke_all')) {
  1826. $in_error_state = TRUE;
  1827. // The user object may not exist in all conditions, so 0 is substituted if needed.
  1828. $user_uid = isset($user->uid) ? $user->uid : 0;
  1829. // Prepare the fields to be logged
  1830. $log_entry = array(
  1831. 'type' => $type,
  1832. 'message' => $message,
  1833. 'variables' => $variables,
  1834. 'severity' => $severity,
  1835. 'link' => $link,
  1836. 'user' => $user,
  1837. 'uid' => $user_uid,
  1838. 'request_uri' => $base_root . request_uri(),
  1839. 'referer' => isset($_SERVER['HTTP_REFERER']) ? $_SERVER['HTTP_REFERER'] : '',
  1840. 'ip' => ip_address(),
  1841. // Request time isn't accurate for long processes, use time() instead.
  1842. 'timestamp' => time(),
  1843. );
  1844. // Call the logging hooks to log/process the message
  1845. module_invoke_all('watchdog', $log_entry);
  1846. // It is critical that the semaphore is only cleared here, in the parent
  1847. // watchdog() call (not outside the loop), to prevent recursive execution.
  1848. $in_error_state = FALSE;
  1849. }
  1850. }
  1851. /**
  1852. * Sets a message to display to the user.
  1853. *
  1854. * Messages are stored in a session variable and displayed in page.tpl.php via
  1855. * the $messages theme variable.
  1856. *
  1857. * Example usage:
  1858. * @code
  1859. * drupal_set_message(t('An error occurred and processing did not complete.'), 'error');
  1860. * @endcode
  1861. *
  1862. * @param string $message
  1863. * (optional) The translated message to be displayed to the user. For
  1864. * consistency with other messages, it should begin with a capital letter and
  1865. * end with a period.
  1866. * @param string $type
  1867. * (optional) The message's type. Defaults to 'status'. These values are
  1868. * supported:
  1869. * - 'status'
  1870. * - 'warning'
  1871. * - 'error'
  1872. * @param bool $repeat
  1873. * (optional) If this is FALSE and the message is already set, then the
  1874. * message won't be repeated. Defaults to TRUE.
  1875. *
  1876. * @return array|null
  1877. * A multidimensional array with keys corresponding to the set message types.
  1878. * The indexed array values of each contain the set messages for that type.
  1879. * Or, if there are no messages set, the function returns NULL.
  1880. *
  1881. * @see drupal_get_messages()
  1882. * @see theme_status_messages()
  1883. */
  1884. function drupal_set_message($message = NULL, $type = 'status', $repeat = TRUE) {
  1885. if ($message || $message === '0' || $message === 0) {
  1886. if (!isset($_SESSION['messages'][$type])) {
  1887. $_SESSION['messages'][$type] = array();
  1888. }
  1889. if ($repeat || !in_array($message, $_SESSION['messages'][$type])) {
  1890. $_SESSION['messages'][$type][] = $message;
  1891. }
  1892. // Mark this page as being uncacheable.
  1893. drupal_page_is_cacheable(FALSE);
  1894. }
  1895. // Messages not set when DB connection fails.
  1896. return isset($_SESSION['messages']) ? $_SESSION['messages'] : NULL;
  1897. }
  1898. /**
  1899. * Returns all messages that have been set with drupal_set_message().
  1900. *
  1901. * @param string $type
  1902. * (optional) Limit the messages returned by type. Defaults to NULL, meaning
  1903. * all types. These values are supported:
  1904. * - NULL
  1905. * - 'status'
  1906. * - 'warning'
  1907. * - 'error'
  1908. * @param bool $clear_queue
  1909. * (optional) If this is TRUE, the queue will be cleared of messages of the
  1910. * type specified in the $type parameter. Otherwise the queue will be left
  1911. * intact. Defaults to TRUE.
  1912. *
  1913. * @return array
  1914. * A multidimensional array with keys corresponding to the set message types.
  1915. * The indexed array values of each contain the set messages for that type.
  1916. * The messages returned are limited to the type specified in the $type
  1917. * parameter. If there are no messages of the specified type, an empty array
  1918. * is returned.
  1919. *
  1920. * @see drupal_set_message()
  1921. * @see theme_status_messages()
  1922. */
  1923. function drupal_get_messages($type = NULL, $clear_queue = TRUE) {
  1924. if ($messages = drupal_set_message()) {
  1925. if ($type) {
  1926. if ($clear_queue) {
  1927. unset($_SESSION['messages'][$type]);
  1928. }
  1929. if (isset($messages[$type])) {
  1930. return array($type => $messages[$type]);
  1931. }
  1932. }
  1933. else {
  1934. if ($clear_queue) {
  1935. unset($_SESSION['messages']);
  1936. }
  1937. return $messages;
  1938. }
  1939. }
  1940. return array();
  1941. }
  1942. /**
  1943. * Gets the title of the current page.
  1944. *
  1945. * The title is displayed on the page and in the title bar.
  1946. *
  1947. * @return
  1948. * The current page's title.
  1949. */
  1950. function drupal_get_title() {
  1951. $title = drupal_set_title();
  1952. // During a bootstrap, menu.inc is not included and thus we cannot provide a title.
  1953. if (!isset($title) && function_exists('menu_get_active_title')) {
  1954. $title = check_plain(menu_get_active_title());
  1955. }
  1956. return $title;
  1957. }
  1958. /**
  1959. * Sets the title of the current page.
  1960. *
  1961. * The title is displayed on the page and in the title bar.
  1962. *
  1963. * @param $title
  1964. * Optional string value to assign to the page title; or if set to NULL
  1965. * (default), leaves the current title unchanged.
  1966. * @param $output
  1967. * Optional flag - normally should be left as CHECK_PLAIN. Only set to
  1968. * PASS_THROUGH if you have already removed any possibly dangerous code
  1969. * from $title using a function like check_plain() or filter_xss(). With this
  1970. * flag the string will be passed through unchanged.
  1971. *
  1972. * @return
  1973. * The updated title of the current page.
  1974. */
  1975. function drupal_set_title($title = NULL, $output = CHECK_PLAIN) {
  1976. $stored_title = &drupal_static(__FUNCTION__);
  1977. if (isset($title)) {
  1978. $stored_title = ($output == PASS_THROUGH) ? $title : check_plain($title);
  1979. }
  1980. return $stored_title;
  1981. }
  1982. /**
  1983. * Checks to see if an IP address has been blocked.
  1984. *
  1985. * Blocked IP addresses are stored in the database by default. However for
  1986. * performance reasons we allow an override in settings.php. This allows us
  1987. * to avoid querying the database at this critical stage of the bootstrap if
  1988. * an administrative interface for IP address blocking is not required.
  1989. *
  1990. * @param $ip
  1991. * IP address to check.
  1992. *
  1993. * @return bool
  1994. * TRUE if access is denied, FALSE if access is allowed.
  1995. */
  1996. function drupal_is_denied($ip) {
  1997. // Because this function is called on every page request, we first check
  1998. // for an array of IP addresses in settings.php before querying the
  1999. // database.
  2000. $blocked_ips = variable_get('blocked_ips');
  2001. $denied = FALSE;
  2002. if (isset($blocked_ips) && is_array($blocked_ips)) {
  2003. $denied = in_array($ip, $blocked_ips);
  2004. }
  2005. // Only check if database.inc is loaded already. If
  2006. // $conf['page_cache_without_database'] = TRUE; is set in settings.php,
  2007. // then the database won't be loaded here so the IPs in the database
  2008. // won't be denied. However the user asked explicitly not to use the
  2009. // database and also in this case it's quite likely that the user relies
  2010. // on higher performance solutions like a firewall.
  2011. elseif (class_exists('Database', FALSE)) {
  2012. $denied = (bool)db_query("SELECT 1 FROM {blocked_ips} WHERE ip = :ip", array(':ip' => $ip))->fetchField();
  2013. }
  2014. return $denied;
  2015. }
  2016. /**
  2017. * Handles denied users.
  2018. *
  2019. * @param $ip
  2020. * IP address to check. Prints a message and exits if access is denied.
  2021. */
  2022. function drupal_block_denied($ip) {
  2023. // Deny access to blocked IP addresses - t() is not yet available.
  2024. if (drupal_is_denied($ip)) {
  2025. header($_SERVER['SERVER_PROTOCOL'] . ' 403 Forbidden');
  2026. print 'Sorry, ' . check_plain(ip_address()) . ' has been banned.';
  2027. exit();
  2028. }
  2029. }
  2030. /**
  2031. * Returns a URL-safe, base64 encoded string of highly randomized bytes (over the full 8-bit range).
  2032. *
  2033. * @param $byte_count
  2034. * The number of random bytes to fetch and base64 encode.
  2035. *
  2036. * @return string
  2037. * The base64 encoded result will have a length of up to 4 * $byte_count.
  2038. */
  2039. function drupal_random_key($byte_count = 32) {
  2040. return drupal_base64_encode(drupal_random_bytes($byte_count));
  2041. }
  2042. /**
  2043. * Returns a URL-safe, base64 encoded version of the supplied string.
  2044. *
  2045. * @param $string
  2046. * The string to convert to base64.
  2047. *
  2048. * @return string
  2049. */
  2050. function drupal_base64_encode($string) {
  2051. $data = base64_encode($string);
  2052. // Modify the output so it's safe to use in URLs.
  2053. return strtr($data, array('+' => '-', '/' => '_', '=' => ''));
  2054. }
  2055. /**
  2056. * Returns a string of highly randomized bytes (over the full 8-bit range).
  2057. *
  2058. * This function is better than simply calling mt_rand() or any other built-in
  2059. * PHP function because it can return a long string of bytes (compared to < 4
  2060. * bytes normally from mt_rand()) and uses the best available pseudo-random
  2061. * source.
  2062. *
  2063. * @param $count
  2064. * The number of characters (bytes) to return in the string.
  2065. */
  2066. function drupal_random_bytes($count) {
  2067. // $random_state does not use drupal_static as it stores random bytes.
  2068. static $random_state, $bytes, $has_openssl;
  2069. $missing_bytes = $count - strlen($bytes);
  2070. if ($missing_bytes > 0) {
  2071. // PHP versions prior 5.3.4 experienced openssl_random_pseudo_bytes()
  2072. // locking on Windows and rendered it unusable.
  2073. if (!isset($has_openssl)) {
  2074. $has_openssl = version_compare(PHP_VERSION, '5.3.4', '>=') && function_exists('openssl_random_pseudo_bytes');
  2075. }
  2076. // openssl_random_pseudo_bytes() will find entropy in a system-dependent
  2077. // way.
  2078. if ($has_openssl) {
  2079. $bytes .= openssl_random_pseudo_bytes($missing_bytes);
  2080. }
  2081. // Else, read directly from /dev/urandom, which is available on many *nix
  2082. // systems and is considered cryptographically secure.
  2083. elseif ($fh = @fopen('/dev/urandom', 'rb')) {
  2084. // PHP only performs buffered reads, so in reality it will always read
  2085. // at least 4096 bytes. Thus, it costs nothing extra to read and store
  2086. // that much so as to speed any additional invocations.
  2087. $bytes .= fread($fh, max(4096, $missing_bytes));
  2088. fclose($fh);
  2089. }
  2090. // If we couldn't get enough entropy, this simple hash-based PRNG will
  2091. // generate a good set of pseudo-random bytes on any system.
  2092. // Note that it may be important that our $random_state is passed
  2093. // through hash() prior to being rolled into $output, that the two hash()
  2094. // invocations are different, and that the extra input into the first one -
  2095. // the microtime() - is prepended rather than appended. This is to avoid
  2096. // directly leaking $random_state via the $output stream, which could
  2097. // allow for trivial prediction of further "random" numbers.
  2098. if (strlen($bytes) < $count) {
  2099. // Initialize on the first call. The contents of $_SERVER includes a mix of
  2100. // user-specific and system information that varies a little with each page.
  2101. if (!isset($random_state)) {
  2102. $random_state = print_r($_SERVER, TRUE);
  2103. if (function_exists('getmypid')) {
  2104. // Further initialize with the somewhat random PHP process ID.
  2105. $random_state .= getmypid();
  2106. }
  2107. $bytes = '';
  2108. }
  2109. do {
  2110. $random_state = hash('sha256', microtime() . mt_rand() . $random_state);
  2111. $bytes .= hash('sha256', mt_rand() . $random_state, TRUE);
  2112. }
  2113. while (strlen($bytes) < $count);
  2114. }
  2115. }
  2116. $output = substr($bytes, 0, $count);
  2117. $bytes = substr($bytes, $count);
  2118. return $output;
  2119. }
  2120. /**
  2121. * Calculates a base-64 encoded, URL-safe sha-256 hmac.
  2122. *
  2123. * @param string $data
  2124. * String to be validated with the hmac.
  2125. * @param string $key
  2126. * A secret string key.
  2127. *
  2128. * @return string
  2129. * A base-64 encoded sha-256 hmac, with + replaced with -, / with _ and
  2130. * any = padding characters removed.
  2131. */
  2132. function drupal_hmac_base64($data, $key) {
  2133. // Casting $data and $key to strings here is necessary to avoid empty string
  2134. // results of the hash function if they are not scalar values. As this
  2135. // function is used in security-critical contexts like token validation it is
  2136. // important that it never returns an empty string.
  2137. $hmac = base64_encode(hash_hmac('sha256', (string) $data, (string) $key, TRUE));
  2138. // Modify the hmac so it's safe to use in URLs.
  2139. return strtr($hmac, array('+' => '-', '/' => '_', '=' => ''));
  2140. }
  2141. /**
  2142. * Calculates a base-64 encoded, URL-safe sha-256 hash.
  2143. *
  2144. * @param $data
  2145. * String to be hashed.
  2146. *
  2147. * @return
  2148. * A base-64 encoded sha-256 hash, with + replaced with -, / with _ and
  2149. * any = padding characters removed.
  2150. */
  2151. function drupal_hash_base64($data) {
  2152. $hash = base64_encode(hash('sha256', $data, TRUE));
  2153. // Modify the hash so it's safe to use in URLs.
  2154. return strtr($hash, array('+' => '-', '/' => '_', '=' => ''));
  2155. }
  2156. /**
  2157. * Merges multiple arrays, recursively, and returns the merged array.
  2158. *
  2159. * This function is similar to PHP's array_merge_recursive() function, but it
  2160. * handles non-array values differently. When merging values that are not both
  2161. * arrays, the latter value replaces the former rather than merging with it.
  2162. *
  2163. * Example:
  2164. * @code
  2165. * $link_options_1 = array('fragment' => 'x', 'attributes' => array('title' => t('X'), 'class' => array('a', 'b')));
  2166. * $link_options_2 = array('fragment' => 'y', 'attributes' => array('title' => t('Y'), 'class' => array('c', 'd')));
  2167. *
  2168. * // This results in array('fragment' => array('x', 'y'), 'attributes' => array('title' => array(t('X'), t('Y')), 'class' => array('a', 'b', 'c', 'd'))).
  2169. * $incorrect = array_merge_recursive($link_options_1, $link_options_2);
  2170. *
  2171. * // This results in array('fragment' => 'y', 'attributes' => array('title' => t('Y'), 'class' => array('a', 'b', 'c', 'd'))).
  2172. * $correct = drupal_array_merge_deep($link_options_1, $link_options_2);
  2173. * @endcode
  2174. *
  2175. * @param ...
  2176. * Arrays to merge.
  2177. *
  2178. * @return
  2179. * The merged array.
  2180. *
  2181. * @see drupal_array_merge_deep_array()
  2182. */
  2183. function drupal_array_merge_deep() {
  2184. $args = func_get_args();
  2185. return drupal_array_merge_deep_array($args);
  2186. }
  2187. /**
  2188. * Merges multiple arrays, recursively, and returns the merged array.
  2189. *
  2190. * This function is equivalent to drupal_array_merge_deep(), except the
  2191. * input arrays are passed as a single array parameter rather than a variable
  2192. * parameter list.
  2193. *
  2194. * The following are equivalent:
  2195. * - drupal_array_merge_deep($a, $b);
  2196. * - drupal_array_merge_deep_array(array($a, $b));
  2197. *
  2198. * The following are also equivalent:
  2199. * - call_user_func_array('drupal_array_merge_deep', $arrays_to_merge);
  2200. * - drupal_array_merge_deep_array($arrays_to_merge);
  2201. *
  2202. * @see drupal_array_merge_deep()
  2203. */
  2204. function drupal_array_merge_deep_array($arrays) {
  2205. $result = array();
  2206. foreach ($arrays as $array) {
  2207. foreach ($array as $key => $value) {
  2208. // Renumber integer keys as array_merge_recursive() does. Note that PHP
  2209. // automatically converts array keys that are integer strings (e.g., '1')
  2210. // to integers.
  2211. if (is_integer($key)) {
  2212. $result[] = $value;
  2213. }
  2214. // Recurse when both values are arrays.
  2215. elseif (isset($result[$key]) && is_array($result[$key]) && is_array($value)) {
  2216. $result[$key] = drupal_array_merge_deep_array(array($result[$key], $value));
  2217. }
  2218. // Otherwise, use the latter value, overriding any previous value.
  2219. else {
  2220. $result[$key] = $value;
  2221. }
  2222. }
  2223. }
  2224. return $result;
  2225. }
  2226. /**
  2227. * Generates a default anonymous $user object.
  2228. *
  2229. * @return Object - the user object.
  2230. */
  2231. function drupal_anonymous_user() {
  2232. $user = variable_get('drupal_anonymous_user_object', new stdClass);
  2233. $user->uid = 0;
  2234. $user->hostname = ip_address();
  2235. $user->roles = array();
  2236. $user->roles[DRUPAL_ANONYMOUS_RID] = 'anonymous user';
  2237. $user->cache = 0;
  2238. return $user;
  2239. }
  2240. /**
  2241. * Ensures Drupal is bootstrapped to the specified phase.
  2242. *
  2243. * In order to bootstrap Drupal from another PHP script, you can use this code:
  2244. * @code
  2245. * define('DRUPAL_ROOT', '/path/to/drupal');
  2246. * require_once DRUPAL_ROOT . '/includes/bootstrap.inc';
  2247. * drupal_bootstrap(DRUPAL_BOOTSTRAP_FULL);
  2248. * @endcode
  2249. *
  2250. * @param int $phase
  2251. * A constant telling which phase to bootstrap to. When you bootstrap to a
  2252. * particular phase, all earlier phases are run automatically. Possible
  2253. * values:
  2254. * - DRUPAL_BOOTSTRAP_CONFIGURATION: Initializes configuration.
  2255. * - DRUPAL_BOOTSTRAP_PAGE_CACHE: Tries to serve a cached page.
  2256. * - DRUPAL_BOOTSTRAP_DATABASE: Initializes the database layer.
  2257. * - DRUPAL_BOOTSTRAP_VARIABLES: Initializes the variable system.
  2258. * - DRUPAL_BOOTSTRAP_SESSION: Initializes session handling.
  2259. * - DRUPAL_BOOTSTRAP_PAGE_HEADER: Sets up the page header.
  2260. * - DRUPAL_BOOTSTRAP_LANGUAGE: Finds out the language of the page.
  2261. * - DRUPAL_BOOTSTRAP_FULL: Fully loads Drupal. Validates and fixes input
  2262. * data.
  2263. * @param boolean $new_phase
  2264. * A boolean, set to FALSE if calling drupal_bootstrap from inside a
  2265. * function called from drupal_bootstrap (recursion).
  2266. *
  2267. * @return int
  2268. * The most recently completed phase.
  2269. */
  2270. function drupal_bootstrap($phase = NULL, $new_phase = TRUE) {
  2271. // Not drupal_static(), because does not depend on any run-time information.
  2272. static $phases = array(
  2273. DRUPAL_BOOTSTRAP_CONFIGURATION,
  2274. DRUPAL_BOOTSTRAP_PAGE_CACHE,
  2275. DRUPAL_BOOTSTRAP_DATABASE,
  2276. DRUPAL_BOOTSTRAP_VARIABLES,
  2277. DRUPAL_BOOTSTRAP_SESSION,
  2278. DRUPAL_BOOTSTRAP_PAGE_HEADER,
  2279. DRUPAL_BOOTSTRAP_LANGUAGE,
  2280. DRUPAL_BOOTSTRAP_FULL,
  2281. );
  2282. // Not drupal_static(), because the only legitimate API to control this is to
  2283. // call drupal_bootstrap() with a new phase parameter.
  2284. static $final_phase;
  2285. // Not drupal_static(), because it's impossible to roll back to an earlier
  2286. // bootstrap state.
  2287. static $stored_phase = -1;
  2288. if (isset($phase)) {
  2289. // When not recursing, store the phase name so it's not forgotten while
  2290. // recursing but take care of not going backwards.
  2291. if ($new_phase && $phase >= $stored_phase) {
  2292. $final_phase = $phase;
  2293. }
  2294. // Call a phase if it has not been called before and is below the requested
  2295. // phase.
  2296. while ($phases && $phase > $stored_phase && $final_phase > $stored_phase) {
  2297. $current_phase = array_shift($phases);
  2298. // This function is re-entrant. Only update the completed phase when the
  2299. // current call actually resulted in a progress in the bootstrap process.
  2300. if ($current_phase > $stored_phase) {
  2301. $stored_phase = $current_phase;
  2302. }
  2303. switch ($current_phase) {
  2304. case DRUPAL_BOOTSTRAP_CONFIGURATION:
  2305. require_once DRUPAL_ROOT . '/includes/request-sanitizer.inc';
  2306. _drupal_bootstrap_configuration();
  2307. break;
  2308. case DRUPAL_BOOTSTRAP_PAGE_CACHE:
  2309. _drupal_bootstrap_page_cache();
  2310. break;
  2311. case DRUPAL_BOOTSTRAP_DATABASE:
  2312. _drupal_bootstrap_database();
  2313. break;
  2314. case DRUPAL_BOOTSTRAP_VARIABLES:
  2315. _drupal_bootstrap_variables();
  2316. break;
  2317. case DRUPAL_BOOTSTRAP_SESSION:
  2318. require_once DRUPAL_ROOT . '/' . variable_get('session_inc', 'includes/session.inc');
  2319. drupal_session_initialize();
  2320. break;
  2321. case DRUPAL_BOOTSTRAP_PAGE_HEADER:
  2322. _drupal_bootstrap_page_header();
  2323. break;
  2324. case DRUPAL_BOOTSTRAP_LANGUAGE:
  2325. drupal_language_initialize();
  2326. break;
  2327. case DRUPAL_BOOTSTRAP_FULL:
  2328. require_once DRUPAL_ROOT . '/includes/common.inc';
  2329. _drupal_bootstrap_full();
  2330. break;
  2331. }
  2332. }
  2333. }
  2334. return $stored_phase;
  2335. }
  2336. /**
  2337. * Returns the time zone of the current user.
  2338. */
  2339. function drupal_get_user_timezone() {
  2340. global $user;
  2341. if (variable_get('configurable_timezones', 1) && $user->uid && $user->timezone) {
  2342. return $user->timezone;
  2343. }
  2344. else {
  2345. // Ignore PHP strict notice if time zone has not yet been set in the php.ini
  2346. // configuration.
  2347. return variable_get('date_default_timezone', @date_default_timezone_get());
  2348. }
  2349. }
  2350. /**
  2351. * Gets a salt useful for hardening against SQL injection.
  2352. *
  2353. * @return
  2354. * A salt based on information in settings.php, not in the database.
  2355. */
  2356. function drupal_get_hash_salt() {
  2357. global $drupal_hash_salt, $databases;
  2358. // If the $drupal_hash_salt variable is empty, a hash of the serialized
  2359. // database credentials is used as a fallback salt.
  2360. return empty($drupal_hash_salt) ? hash('sha256', serialize($databases)) : $drupal_hash_salt;
  2361. }
  2362. /**
  2363. * Provides custom PHP error handling.
  2364. *
  2365. * @param $error_level
  2366. * The level of the error raised.
  2367. * @param $message
  2368. * The error message.
  2369. * @param $filename
  2370. * The filename that the error was raised in.
  2371. * @param $line
  2372. * The line number the error was raised at.
  2373. * @param $context
  2374. * An array that points to the active symbol table at the point the error
  2375. * occurred.
  2376. */
  2377. function _drupal_error_handler($error_level, $message, $filename, $line, $context) {
  2378. require_once DRUPAL_ROOT . '/includes/errors.inc';
  2379. _drupal_error_handler_real($error_level, $message, $filename, $line, $context);
  2380. }
  2381. /**
  2382. * Provides custom PHP exception handling.
  2383. *
  2384. * Uncaught exceptions are those not enclosed in a try/catch block. They are
  2385. * always fatal: the execution of the script will stop as soon as the exception
  2386. * handler exits.
  2387. *
  2388. * @param $exception
  2389. * The exception object that was thrown.
  2390. */
  2391. function _drupal_exception_handler($exception) {
  2392. require_once DRUPAL_ROOT . '/includes/errors.inc';
  2393. try {
  2394. // Log the message to the watchdog and return an error page to the user.
  2395. _drupal_log_error(_drupal_decode_exception($exception), TRUE);
  2396. }
  2397. catch (Exception $exception2) {
  2398. // Add a 500 status code in case an exception was thrown before the 500
  2399. // status could be set (e.g. while loading a maintenance theme from cache).
  2400. drupal_add_http_header('Status', '500 Internal Server Error');
  2401. // Another uncaught exception was thrown while handling the first one.
  2402. // If we are displaying errors, then do so with no possibility of a further uncaught exception being thrown.
  2403. if (error_displayable()) {
  2404. print '<h1>Additional uncaught exception thrown while handling exception.</h1>';
  2405. print '<h2>Original</h2><p>' . _drupal_render_exception_safe($exception) . '</p>';
  2406. print '<h2>Additional</h2><p>' . _drupal_render_exception_safe($exception2) . '</p><hr />';
  2407. }
  2408. }
  2409. }
  2410. /**
  2411. * Sets up the script environment and loads settings.php.
  2412. */
  2413. function _drupal_bootstrap_configuration() {
  2414. // Set the Drupal custom error handler.
  2415. set_error_handler('_drupal_error_handler');
  2416. set_exception_handler('_drupal_exception_handler');
  2417. drupal_environment_initialize();
  2418. // Start a page timer:
  2419. timer_start('page');
  2420. // Initialize the configuration, including variables from settings.php.
  2421. drupal_settings_initialize();
  2422. // Sanitize unsafe keys from the request.
  2423. DrupalRequestSanitizer::sanitize();
  2424. }
  2425. /**
  2426. * Attempts to serve a page from the cache.
  2427. */
  2428. function _drupal_bootstrap_page_cache() {
  2429. global $user;
  2430. // Allow specifying special cache handlers in settings.php, like
  2431. // using memcached or files for storing cache information.
  2432. require_once DRUPAL_ROOT . '/includes/cache.inc';
  2433. foreach (variable_get('cache_backends', array()) as $include) {
  2434. require_once DRUPAL_ROOT . '/' . $include;
  2435. }
  2436. // Check for a cache mode force from settings.php.
  2437. if (variable_get('page_cache_without_database')) {
  2438. $cache_enabled = TRUE;
  2439. }
  2440. else {
  2441. drupal_bootstrap(DRUPAL_BOOTSTRAP_VARIABLES, FALSE);
  2442. $cache_enabled = variable_get('cache');
  2443. }
  2444. drupal_block_denied(ip_address());
  2445. // If there is no session cookie and cache is enabled (or forced), try
  2446. // to serve a cached page.
  2447. if (!isset($_COOKIE[session_name()]) && $cache_enabled) {
  2448. // Make sure there is a user object because its timestamp will be
  2449. // checked, hook_boot might check for anonymous user etc.
  2450. $user = drupal_anonymous_user();
  2451. // Get the page from the cache.
  2452. $cache = drupal_page_get_cache();
  2453. // If there is a cached page, display it.
  2454. if (is_object($cache)) {
  2455. header('X-Drupal-Cache: HIT');
  2456. // Restore the metadata cached with the page.
  2457. $_GET['q'] = $cache->data['path'];
  2458. drupal_set_title($cache->data['title'], PASS_THROUGH);
  2459. date_default_timezone_set(drupal_get_user_timezone());
  2460. // If the skipping of the bootstrap hooks is not enforced, call
  2461. // hook_boot.
  2462. if (variable_get('page_cache_invoke_hooks', TRUE)) {
  2463. bootstrap_invoke_all('boot');
  2464. }
  2465. drupal_serve_page_from_cache($cache);
  2466. // If the skipping of the bootstrap hooks is not enforced, call
  2467. // hook_exit.
  2468. if (variable_get('page_cache_invoke_hooks', TRUE)) {
  2469. bootstrap_invoke_all('exit');
  2470. }
  2471. // We are done.
  2472. exit;
  2473. }
  2474. else {
  2475. header('X-Drupal-Cache: MISS');
  2476. }
  2477. }
  2478. }
  2479. /**
  2480. * Initializes the database system and registers autoload functions.
  2481. */
  2482. function _drupal_bootstrap_database() {
  2483. // Redirect the user to the installation script if Drupal has not been
  2484. // installed yet (i.e., if no $databases array has been defined in the
  2485. // settings.php file) and we are not already installing.
  2486. if (empty($GLOBALS['databases']) && !drupal_installation_attempted()) {
  2487. include_once DRUPAL_ROOT . '/includes/install.inc';
  2488. install_goto('install.php');
  2489. }
  2490. // The user agent header is used to pass a database prefix in the request when
  2491. // running tests. However, for security reasons, it is imperative that we
  2492. // validate we ourselves made the request.
  2493. if ($test_prefix = drupal_valid_test_ua()) {
  2494. // Set the test run id for use in other parts of Drupal.
  2495. $test_info = &$GLOBALS['drupal_test_info'];
  2496. $test_info['test_run_id'] = $test_prefix;
  2497. $test_info['in_child_site'] = TRUE;
  2498. foreach ($GLOBALS['databases']['default'] as &$value) {
  2499. // Extract the current default database prefix.
  2500. if (!isset($value['prefix'])) {
  2501. $current_prefix = '';
  2502. }
  2503. elseif (is_array($value['prefix'])) {
  2504. $current_prefix = $value['prefix']['default'];
  2505. }
  2506. else {
  2507. $current_prefix = $value['prefix'];
  2508. }
  2509. // Remove the current database prefix and replace it by our own.
  2510. $value['prefix'] = array(
  2511. 'default' => $current_prefix . $test_prefix,
  2512. );
  2513. }
  2514. }
  2515. // Initialize the database system. Note that the connection
  2516. // won't be initialized until it is actually requested.
  2517. require_once DRUPAL_ROOT . '/includes/database/database.inc';
  2518. // Register autoload functions so that we can access classes and interfaces.
  2519. // The database autoload routine comes first so that we can load the database
  2520. // system without hitting the database. That is especially important during
  2521. // the install or upgrade process.
  2522. spl_autoload_register('drupal_autoload_class');
  2523. spl_autoload_register('drupal_autoload_interface');
  2524. if (version_compare(PHP_VERSION, '5.4') >= 0) {
  2525. spl_autoload_register('drupal_autoload_trait');
  2526. }
  2527. }
  2528. /**
  2529. * Loads system variables and all enabled bootstrap modules.
  2530. */
  2531. function _drupal_bootstrap_variables() {
  2532. global $conf;
  2533. // Initialize the lock system.
  2534. require_once DRUPAL_ROOT . '/' . variable_get('lock_inc', 'includes/lock.inc');
  2535. lock_initialize();
  2536. // Load variables from the database, but do not overwrite variables set in settings.php.
  2537. $conf = variable_initialize(isset($conf) ? $conf : array());
  2538. // Load bootstrap modules.
  2539. require_once DRUPAL_ROOT . '/includes/module.inc';
  2540. module_load_all(TRUE);
  2541. // Sanitize the destination parameter (which is often used for redirects) to
  2542. // prevent open redirect attacks leading to other domains. Sanitize both
  2543. // $_GET['destination'] and $_REQUEST['destination'] to protect code that
  2544. // relies on either, but do not sanitize $_POST to avoid interfering with
  2545. // unrelated form submissions. The sanitization happens here because
  2546. // url_is_external() requires the variable system to be available.
  2547. if (isset($_GET['destination']) || isset($_REQUEST['destination'])) {
  2548. require_once DRUPAL_ROOT . '/includes/common.inc';
  2549. // If the destination is an external URL, remove it.
  2550. if (isset($_GET['destination']) && url_is_external($_GET['destination'])) {
  2551. unset($_GET['destination']);
  2552. unset($_REQUEST['destination']);
  2553. }
  2554. // Use the DrupalRequestSanitizer to ensure that the destination's query
  2555. // parameters are not dangerous.
  2556. if (isset($_GET['destination'])) {
  2557. DrupalRequestSanitizer::cleanDestination();
  2558. }
  2559. // If there's still something in $_REQUEST['destination'] that didn't come
  2560. // from $_GET, check it too.
  2561. if (isset($_REQUEST['destination']) && (!isset($_GET['destination']) || $_REQUEST['destination'] != $_GET['destination']) && url_is_external($_REQUEST['destination'])) {
  2562. unset($_REQUEST['destination']);
  2563. }
  2564. }
  2565. }
  2566. /**
  2567. * Invokes hook_boot(), initializes locking system, and sends HTTP headers.
  2568. */
  2569. function _drupal_bootstrap_page_header() {
  2570. bootstrap_invoke_all('boot');
  2571. if (!drupal_is_cli()) {
  2572. ob_start();
  2573. drupal_page_header();
  2574. }
  2575. }
  2576. /**
  2577. * Returns the current bootstrap phase for this Drupal process.
  2578. *
  2579. * The current phase is the one most recently completed by drupal_bootstrap().
  2580. *
  2581. * @see drupal_bootstrap()
  2582. */
  2583. function drupal_get_bootstrap_phase() {
  2584. return drupal_bootstrap(NULL, FALSE);
  2585. }
  2586. /**
  2587. * Returns the test prefix if this is an internal request from SimpleTest.
  2588. *
  2589. * @return
  2590. * Either the simpletest prefix (the string "simpletest" followed by any
  2591. * number of digits) or FALSE if the user agent does not contain a valid
  2592. * HMAC and timestamp.
  2593. */
  2594. function drupal_valid_test_ua() {
  2595. // No reason to reset this.
  2596. static $test_prefix;
  2597. if (isset($test_prefix)) {
  2598. return $test_prefix;
  2599. }
  2600. if (isset($_SERVER['HTTP_USER_AGENT']) && preg_match("/^(simpletest\d+);(.+);(.+);(.+)$/", $_SERVER['HTTP_USER_AGENT'], $matches)) {
  2601. list(, $prefix, $time, $salt, $hmac) = $matches;
  2602. $check_string = $prefix . ';' . $time . ';' . $salt;
  2603. // We use the salt from settings.php to make the HMAC key, since
  2604. // the database is not yet initialized and we can't access any Drupal variables.
  2605. // The file properties add more entropy not easily accessible to others.
  2606. $key = drupal_get_hash_salt() . filectime(__FILE__) . fileinode(__FILE__);
  2607. $time_diff = REQUEST_TIME - $time;
  2608. // Since we are making a local request a 5 second time window is allowed,
  2609. // and the HMAC must match.
  2610. if ($time_diff >= 0 && $time_diff <= 5 && $hmac == drupal_hmac_base64($check_string, $key)) {
  2611. $test_prefix = $prefix;
  2612. return $test_prefix;
  2613. }
  2614. }
  2615. $test_prefix = FALSE;
  2616. return $test_prefix;
  2617. }
  2618. /**
  2619. * Generates a user agent string with a HMAC and timestamp for simpletest.
  2620. */
  2621. function drupal_generate_test_ua($prefix) {
  2622. static $key;
  2623. if (!isset($key)) {
  2624. // We use the salt from settings.php to make the HMAC key, since
  2625. // the database is not yet initialized and we can't access any Drupal variables.
  2626. // The file properties add more entropy not easily accessible to others.
  2627. $key = drupal_get_hash_salt() . filectime(__FILE__) . fileinode(__FILE__);
  2628. }
  2629. // Generate a moderately secure HMAC based on the database credentials.
  2630. $salt = uniqid('', TRUE);
  2631. $check_string = $prefix . ';' . time() . ';' . $salt;
  2632. return $check_string . ';' . drupal_hmac_base64($check_string, $key);
  2633. }
  2634. /**
  2635. * Enables use of the theme system without requiring database access.
  2636. *
  2637. * Loads and initializes the theme system for site installs, updates and when
  2638. * the site is in maintenance mode. This also applies when the database fails.
  2639. *
  2640. * @see _drupal_maintenance_theme()
  2641. */
  2642. function drupal_maintenance_theme() {
  2643. require_once DRUPAL_ROOT . '/includes/theme.maintenance.inc';
  2644. _drupal_maintenance_theme();
  2645. }
  2646. /**
  2647. * Returns a simple 404 Not Found page.
  2648. *
  2649. * If fast 404 pages are enabled, and this is a matching page then print a
  2650. * simple 404 page and exit.
  2651. *
  2652. * This function is called from drupal_deliver_html_page() at the time when a
  2653. * a normal 404 page is generated, but it can also optionally be called directly
  2654. * from settings.php to prevent a Drupal bootstrap on these pages. See
  2655. * documentation in settings.php for the benefits and drawbacks of using this.
  2656. *
  2657. * Paths to dynamically-generated content, such as image styles, should also be
  2658. * accounted for in this function.
  2659. */
  2660. function drupal_fast_404() {
  2661. $exclude_paths = variable_get('404_fast_paths_exclude', FALSE);
  2662. if ($exclude_paths && !preg_match($exclude_paths, $_GET['q'])) {
  2663. $fast_paths = variable_get('404_fast_paths', FALSE);
  2664. if ($fast_paths && preg_match($fast_paths, $_GET['q'])) {
  2665. drupal_add_http_header('Status', '404 Not Found');
  2666. $fast_404_html = variable_get('404_fast_html', '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML+RDFa 1.0//EN" "http://www.w3.org/MarkUp/DTD/xhtml-rdfa-1.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><title>404 Not Found</title></head><body><h1>Not Found</h1><p>The requested URL "@path" was not found on this server.</p></body></html>');
  2667. // Replace @path in the variable with the page path.
  2668. print strtr($fast_404_html, array('@path' => check_plain(request_uri())));
  2669. exit;
  2670. }
  2671. }
  2672. }
  2673. /**
  2674. * Returns TRUE if a Drupal installation is currently being attempted.
  2675. */
  2676. function drupal_installation_attempted() {
  2677. return defined('MAINTENANCE_MODE') && MAINTENANCE_MODE == 'install';
  2678. }
  2679. /**
  2680. * Returns the name of the proper localization function.
  2681. *
  2682. * get_t() exists to support localization for code that might run during
  2683. * the installation phase, when some elements of the system might not have
  2684. * loaded.
  2685. *
  2686. * This would include implementations of hook_install(), which could run
  2687. * during the Drupal installation phase, and might also be run during
  2688. * non-installation time, such as while installing the module from the
  2689. * module administration page.
  2690. *
  2691. * Example usage:
  2692. * @code
  2693. * $t = get_t();
  2694. * $translated = $t('translate this');
  2695. * @endcode
  2696. *
  2697. * Use t() if your code will never run during the Drupal installation phase.
  2698. * Use st() if your code will only run during installation and never any other
  2699. * time. Use get_t() if your code could run in either circumstance.
  2700. *
  2701. * @see t()
  2702. * @see st()
  2703. * @ingroup sanitization
  2704. */
  2705. function get_t() {
  2706. static $t;
  2707. // This is not converted to drupal_static because there is no point in
  2708. // resetting this as it can not change in the course of a request.
  2709. if (!isset($t)) {
  2710. $t = drupal_installation_attempted() ? 'st' : 't';
  2711. }
  2712. return $t;
  2713. }
  2714. /**
  2715. * Initializes all the defined language types.
  2716. */
  2717. function drupal_language_initialize() {
  2718. $types = language_types();
  2719. // Ensure the language is correctly returned, even without multilanguage
  2720. // support. Also make sure we have a $language fallback, in case a language
  2721. // negotiation callback needs to do a full bootstrap.
  2722. // Useful for eg. XML/HTML 'lang' attributes.
  2723. $default = language_default();
  2724. foreach ($types as $type) {
  2725. $GLOBALS[$type] = $default;
  2726. }
  2727. if (drupal_multilingual()) {
  2728. include_once DRUPAL_ROOT . '/includes/language.inc';
  2729. foreach ($types as $type) {
  2730. $GLOBALS[$type] = language_initialize($type);
  2731. }
  2732. // Allow modules to react on language system initialization in multilingual
  2733. // environments.
  2734. bootstrap_invoke_all('language_init');
  2735. }
  2736. }
  2737. /**
  2738. * Returns a list of the built-in language types.
  2739. *
  2740. * @return
  2741. * An array of key-values pairs where the key is the language type and the
  2742. * value is its configurability.
  2743. */
  2744. function drupal_language_types() {
  2745. return array(
  2746. LANGUAGE_TYPE_INTERFACE => TRUE,
  2747. LANGUAGE_TYPE_CONTENT => FALSE,
  2748. LANGUAGE_TYPE_URL => FALSE,
  2749. );
  2750. }
  2751. /**
  2752. * Returns TRUE if there is more than one language enabled.
  2753. *
  2754. * @return
  2755. * TRUE if more than one language is enabled.
  2756. */
  2757. function drupal_multilingual() {
  2758. // The "language_count" variable stores the number of enabled languages to
  2759. // avoid unnecessarily querying the database when building the list of
  2760. // enabled languages on monolingual sites.
  2761. return variable_get('language_count', 1) > 1;
  2762. }
  2763. /**
  2764. * Returns an array of the available language types.
  2765. *
  2766. * @return
  2767. * An array of all language types where the keys of each are the language type
  2768. * name and its value is its configurability (TRUE/FALSE).
  2769. */
  2770. function language_types() {
  2771. return array_keys(variable_get('language_types', drupal_language_types()));
  2772. }
  2773. /**
  2774. * Returns a list of installed languages, indexed by the specified key.
  2775. *
  2776. * @param $field
  2777. * (optional) The field to index the list with.
  2778. *
  2779. * @return
  2780. * An associative array, keyed on the values of $field.
  2781. * - If $field is 'weight' or 'enabled', the array is nested, with the outer
  2782. * array's values each being associative arrays with language codes as
  2783. * keys and language objects as values.
  2784. * - For all other values of $field, the array is only one level deep, and
  2785. * the array's values are language objects.
  2786. */
  2787. function language_list($field = 'language') {
  2788. $languages = &drupal_static(__FUNCTION__);
  2789. // Init language list
  2790. if (!isset($languages)) {
  2791. if (drupal_multilingual() || module_exists('locale')) {
  2792. $languages['language'] = db_query('SELECT * FROM {languages} ORDER BY weight ASC, name ASC')->fetchAllAssoc('language');
  2793. // Users cannot uninstall the native English language. However, we allow
  2794. // it to be hidden from the installed languages. Therefore, at least one
  2795. // other language must be enabled then.
  2796. if (!$languages['language']['en']->enabled && !variable_get('language_native_enabled', TRUE)) {
  2797. unset($languages['language']['en']);
  2798. }
  2799. }
  2800. else {
  2801. // No locale module, so use the default language only.
  2802. $default = language_default();
  2803. $languages['language'][$default->language] = $default;
  2804. }
  2805. }
  2806. // Return the array indexed by the right field
  2807. if (!isset($languages[$field])) {
  2808. $languages[$field] = array();
  2809. foreach ($languages['language'] as $lang) {
  2810. // Some values should be collected into an array
  2811. if (in_array($field, array('enabled', 'weight'))) {
  2812. $languages[$field][$lang->$field][$lang->language] = $lang;
  2813. }
  2814. else {
  2815. $languages[$field][$lang->$field] = $lang;
  2816. }
  2817. }
  2818. }
  2819. return $languages[$field];
  2820. }
  2821. /**
  2822. * Returns the default language, as an object, or one of its properties.
  2823. *
  2824. * @param $property
  2825. * (optional) The property of the language object to return.
  2826. *
  2827. * @return
  2828. * Either the language object for the default language used on the site,
  2829. * or the property of that object named in the $property parameter.
  2830. */
  2831. function language_default($property = NULL) {
  2832. $language = variable_get('language_default', (object) array('language' => 'en', 'name' => 'English', 'native' => 'English', 'direction' => 0, 'enabled' => 1, 'plurals' => 0, 'formula' => '', 'domain' => '', 'prefix' => '', 'weight' => 0, 'javascript' => ''));
  2833. return $property ? $language->$property : $language;
  2834. }
  2835. /**
  2836. * Returns the requested URL path of the page being viewed.
  2837. *
  2838. * Examples:
  2839. * - http://example.com/node/306 returns "node/306".
  2840. * - http://example.com/drupalfolder/node/306 returns "node/306" while
  2841. * base_path() returns "/drupalfolder/".
  2842. * - http://example.com/path/alias (which is a path alias for node/306) returns
  2843. * "path/alias" as opposed to the internal path.
  2844. * - http://example.com/index.php returns an empty string (meaning: front page).
  2845. * - http://example.com/index.php?page=1 returns an empty string.
  2846. *
  2847. * @return
  2848. * The requested Drupal URL path.
  2849. *
  2850. * @see current_path()
  2851. */
  2852. function request_path() {
  2853. static $path;
  2854. if (isset($path)) {
  2855. return $path;
  2856. }
  2857. if (isset($_GET['q']) && is_string($_GET['q'])) {
  2858. // This is a request with a ?q=foo/bar query string. $_GET['q'] is
  2859. // overwritten in drupal_path_initialize(), but request_path() is called
  2860. // very early in the bootstrap process, so the original value is saved in
  2861. // $path and returned in later calls.
  2862. $path = $_GET['q'];
  2863. }
  2864. elseif (isset($_SERVER['REQUEST_URI'])) {
  2865. // This request is either a clean URL, or 'index.php', or nonsense.
  2866. // Extract the path from REQUEST_URI.
  2867. $request_path = strtok($_SERVER['REQUEST_URI'], '?');
  2868. $base_path_len = strlen(rtrim(dirname($_SERVER['SCRIPT_NAME']), '\/'));
  2869. // Unescape and strip $base_path prefix, leaving q without a leading slash.
  2870. $path = substr(urldecode($request_path), $base_path_len + 1);
  2871. // If the path equals the script filename, either because 'index.php' was
  2872. // explicitly provided in the URL, or because the server added it to
  2873. // $_SERVER['REQUEST_URI'] even when it wasn't provided in the URL (some
  2874. // versions of Microsoft IIS do this), the front page should be served.
  2875. if ($path == basename($_SERVER['PHP_SELF'])) {
  2876. $path = '';
  2877. }
  2878. }
  2879. else {
  2880. // This is the front page.
  2881. $path = '';
  2882. }
  2883. // Under certain conditions Apache's RewriteRule directive prepends the value
  2884. // assigned to $_GET['q'] with a slash. Moreover we can always have a trailing
  2885. // slash in place, hence we need to normalize $_GET['q'].
  2886. $path = trim($path, '/');
  2887. return $path;
  2888. }
  2889. /**
  2890. * Returns a component of the current Drupal path.
  2891. *
  2892. * When viewing a page at the path "admin/structure/types", for example, arg(0)
  2893. * returns "admin", arg(1) returns "structure", and arg(2) returns "types".
  2894. *
  2895. * Avoid use of this function where possible, as resulting code is hard to
  2896. * read. In menu callback functions, attempt to use named arguments. See the
  2897. * explanation in menu.inc for how to construct callbacks that take arguments.
  2898. * When attempting to use this function to load an element from the current
  2899. * path, e.g. loading the node on a node page, use menu_get_object() instead.
  2900. *
  2901. * @param $index
  2902. * The index of the component, where each component is separated by a '/'
  2903. * (forward-slash), and where the first component has an index of 0 (zero).
  2904. * @param $path
  2905. * A path to break into components. Defaults to the path of the current page.
  2906. *
  2907. * @return
  2908. * The component specified by $index, or NULL if the specified component was
  2909. * not found. If called without arguments, it returns an array containing all
  2910. * the components of the current path.
  2911. */
  2912. function arg($index = NULL, $path = NULL) {
  2913. // Even though $arguments doesn't need to be resettable for any functional
  2914. // reasons (the result of explode() does not depend on any run-time
  2915. // information), it should be resettable anyway in case a module needs to
  2916. // free up the memory used by it.
  2917. // Use the advanced drupal_static() pattern, since this is called very often.
  2918. static $drupal_static_fast;
  2919. if (!isset($drupal_static_fast)) {
  2920. $drupal_static_fast['arguments'] = &drupal_static(__FUNCTION__);
  2921. }
  2922. $arguments = &$drupal_static_fast['arguments'];
  2923. if (!isset($path)) {
  2924. $path = $_GET['q'];
  2925. }
  2926. if (!isset($arguments[$path])) {
  2927. $arguments[$path] = explode('/', $path);
  2928. }
  2929. if (!isset($index)) {
  2930. return $arguments[$path];
  2931. }
  2932. if (isset($arguments[$path][$index])) {
  2933. return $arguments[$path][$index];
  2934. }
  2935. }
  2936. /**
  2937. * Returns the IP address of the client machine.
  2938. *
  2939. * If Drupal is behind a reverse proxy, we use the X-Forwarded-For header
  2940. * instead of $_SERVER['REMOTE_ADDR'], which would be the IP address of
  2941. * the proxy server, and not the client's. The actual header name can be
  2942. * configured by the reverse_proxy_header variable.
  2943. *
  2944. * @return
  2945. * IP address of client machine, adjusted for reverse proxy and/or cluster
  2946. * environments.
  2947. */
  2948. function ip_address() {
  2949. $ip_address = &drupal_static(__FUNCTION__);
  2950. if (!isset($ip_address)) {
  2951. $ip_address = $_SERVER['REMOTE_ADDR'];
  2952. if (variable_get('reverse_proxy', 0)) {
  2953. $reverse_proxy_header = variable_get('reverse_proxy_header', 'HTTP_X_FORWARDED_FOR');
  2954. if (!empty($_SERVER[$reverse_proxy_header])) {
  2955. // If an array of known reverse proxy IPs is provided, then trust
  2956. // the XFF header if request really comes from one of them.
  2957. $reverse_proxy_addresses = variable_get('reverse_proxy_addresses', array());
  2958. // Turn XFF header into an array.
  2959. $forwarded = explode(',', $_SERVER[$reverse_proxy_header]);
  2960. // Trim the forwarded IPs; they may have been delimited by commas and spaces.
  2961. $forwarded = array_map('trim', $forwarded);
  2962. // Tack direct client IP onto end of forwarded array.
  2963. $forwarded[] = $ip_address;
  2964. // Eliminate all trusted IPs.
  2965. $untrusted = array_diff($forwarded, $reverse_proxy_addresses);
  2966. if (!empty($untrusted)) {
  2967. // The right-most IP is the most specific we can trust.
  2968. $ip_address = array_pop($untrusted);
  2969. }
  2970. else {
  2971. // All IP addresses in the forwarded array are configured proxy IPs
  2972. // (and thus trusted). We take the leftmost IP.
  2973. $ip_address = array_shift($forwarded);
  2974. }
  2975. }
  2976. }
  2977. }
  2978. return $ip_address;
  2979. }
  2980. /**
  2981. * @addtogroup schemaapi
  2982. * @{
  2983. */
  2984. /**
  2985. * Gets the schema definition of a table, or the whole database schema.
  2986. *
  2987. * The returned schema will include any modifications made by any
  2988. * module that implements hook_schema_alter(). To get the schema without
  2989. * modifications, use drupal_get_schema_unprocessed().
  2990. *
  2991. *
  2992. * @param $table
  2993. * The name of the table. If not given, the schema of all tables is returned.
  2994. * @param $rebuild
  2995. * If true, the schema will be rebuilt instead of retrieved from the cache.
  2996. */
  2997. function drupal_get_schema($table = NULL, $rebuild = FALSE) {
  2998. static $schema;
  2999. if ($rebuild || !isset($table)) {
  3000. $schema = drupal_get_complete_schema($rebuild);
  3001. }
  3002. elseif (!isset($schema)) {
  3003. $schema = new SchemaCache();
  3004. }
  3005. if (!isset($table)) {
  3006. return $schema;
  3007. }
  3008. if (isset($schema[$table])) {
  3009. return $schema[$table];
  3010. }
  3011. else {
  3012. return FALSE;
  3013. }
  3014. }
  3015. /**
  3016. * Extends DrupalCacheArray to allow for dynamic building of the schema cache.
  3017. */
  3018. class SchemaCache extends DrupalCacheArray {
  3019. /**
  3020. * Constructs a SchemaCache object.
  3021. */
  3022. public function __construct() {
  3023. // Cache by request method.
  3024. parent::__construct('schema:runtime:' . ($_SERVER['REQUEST_METHOD'] == 'GET'), 'cache');
  3025. }
  3026. /**
  3027. * Overrides DrupalCacheArray::resolveCacheMiss().
  3028. */
  3029. protected function resolveCacheMiss($offset) {
  3030. $complete_schema = drupal_get_complete_schema();
  3031. $value = isset($complete_schema[$offset]) ? $complete_schema[$offset] : NULL;
  3032. $this->storage[$offset] = $value;
  3033. $this->persist($offset);
  3034. return $value;
  3035. }
  3036. }
  3037. /**
  3038. * Gets the whole database schema.
  3039. *
  3040. * The returned schema will include any modifications made by any
  3041. * module that implements hook_schema_alter().
  3042. *
  3043. * @param $rebuild
  3044. * If true, the schema will be rebuilt instead of retrieved from the cache.
  3045. */
  3046. function drupal_get_complete_schema($rebuild = FALSE) {
  3047. static $schema = array();
  3048. if (empty($schema) || $rebuild) {
  3049. // Try to load the schema from cache.
  3050. if (!$rebuild && $cached = cache_get('schema')) {
  3051. $schema = $cached->data;
  3052. }
  3053. // Otherwise, rebuild the schema cache.
  3054. else {
  3055. $schema = array();
  3056. // Load the .install files to get hook_schema.
  3057. // On some databases this function may be called before bootstrap has
  3058. // been completed, so we force the functions we need to load just in case.
  3059. if (function_exists('module_load_all_includes')) {
  3060. // This function can be called very early in the bootstrap process, so
  3061. // we force the module_list() cache to be refreshed to ensure that it
  3062. // contains the complete list of modules before we go on to call
  3063. // module_load_all_includes().
  3064. module_list(TRUE);
  3065. module_load_all_includes('install');
  3066. }
  3067. require_once DRUPAL_ROOT . '/includes/common.inc';
  3068. // Invoke hook_schema for all modules.
  3069. foreach (module_implements('schema') as $module) {
  3070. // Cast the result of hook_schema() to an array, as a NULL return value
  3071. // would cause array_merge() to set the $schema variable to NULL as well.
  3072. // That would break modules which use $schema further down the line.
  3073. $current = (array) module_invoke($module, 'schema');
  3074. // Set 'module' and 'name' keys for each table, and remove descriptions,
  3075. // as they needlessly slow down cache_get() for every single request.
  3076. _drupal_schema_initialize($current, $module);
  3077. $schema = array_merge($schema, $current);
  3078. }
  3079. drupal_alter('schema', $schema);
  3080. // If the schema is empty, avoid saving it: some database engines require
  3081. // the schema to perform queries, and this could lead to infinite loops.
  3082. if (!empty($schema) && (drupal_get_bootstrap_phase() == DRUPAL_BOOTSTRAP_FULL)) {
  3083. cache_set('schema', $schema);
  3084. }
  3085. if ($rebuild) {
  3086. cache_clear_all('schema:', 'cache', TRUE);
  3087. }
  3088. }
  3089. }
  3090. return $schema;
  3091. }
  3092. /**
  3093. * @} End of "addtogroup schemaapi".
  3094. */
  3095. /**
  3096. * @addtogroup registry
  3097. * @{
  3098. */
  3099. /**
  3100. * Confirms that an interface is available.
  3101. *
  3102. * This function is rarely called directly. Instead, it is registered as an
  3103. * spl_autoload() handler, and PHP calls it for us when necessary.
  3104. *
  3105. * @param $interface
  3106. * The name of the interface to check or load.
  3107. *
  3108. * @return
  3109. * TRUE if the interface is currently available, FALSE otherwise.
  3110. */
  3111. function drupal_autoload_interface($interface) {
  3112. return _registry_check_code('interface', $interface);
  3113. }
  3114. /**
  3115. * Confirms that a class is available.
  3116. *
  3117. * This function is rarely called directly. Instead, it is registered as an
  3118. * spl_autoload() handler, and PHP calls it for us when necessary.
  3119. *
  3120. * @param $class
  3121. * The name of the class to check or load.
  3122. *
  3123. * @return
  3124. * TRUE if the class is currently available, FALSE otherwise.
  3125. */
  3126. function drupal_autoload_class($class) {
  3127. return _registry_check_code('class', $class);
  3128. }
  3129. /**
  3130. * Confirms that a trait is available.
  3131. *
  3132. * This function is rarely called directly. Instead, it is registered as an
  3133. * spl_autoload() handler, and PHP calls it for us when necessary.
  3134. *
  3135. * @param string $trait
  3136. * The name of the trait to check or load.
  3137. *
  3138. * @return bool
  3139. * TRUE if the trait is currently available, FALSE otherwise.
  3140. */
  3141. function drupal_autoload_trait($trait) {
  3142. return _registry_check_code('trait', $trait);
  3143. }
  3144. /**
  3145. * Checks for a resource in the registry.
  3146. *
  3147. * @param $type
  3148. * The type of resource we are looking up, or one of the constants
  3149. * REGISTRY_RESET_LOOKUP_CACHE or REGISTRY_WRITE_LOOKUP_CACHE, which
  3150. * signal that we should reset or write the cache, respectively.
  3151. * @param $name
  3152. * The name of the resource, or NULL if either of the REGISTRY_* constants
  3153. * is passed in.
  3154. *
  3155. * @return
  3156. * TRUE if the resource was found, FALSE if not.
  3157. * NULL if either of the REGISTRY_* constants is passed in as $type.
  3158. */
  3159. function _registry_check_code($type, $name = NULL) {
  3160. static $lookup_cache, $cache_update_needed;
  3161. if ($type == 'class' && class_exists($name) || $type == 'interface' && interface_exists($name) || $type == 'trait' && trait_exists($name)) {
  3162. return TRUE;
  3163. }
  3164. if (!isset($lookup_cache)) {
  3165. $lookup_cache = array();
  3166. if ($cache = cache_get('lookup_cache', 'cache_bootstrap')) {
  3167. $lookup_cache = $cache->data;
  3168. }
  3169. }
  3170. // When we rebuild the registry, we need to reset this cache so
  3171. // we don't keep lookups for resources that changed during the rebuild.
  3172. if ($type == REGISTRY_RESET_LOOKUP_CACHE) {
  3173. $cache_update_needed = TRUE;
  3174. $lookup_cache = NULL;
  3175. return;
  3176. }
  3177. // Called from drupal_page_footer, we write to permanent storage if there
  3178. // changes to the lookup cache for this request.
  3179. if ($type == REGISTRY_WRITE_LOOKUP_CACHE) {
  3180. if ($cache_update_needed) {
  3181. cache_set('lookup_cache', $lookup_cache, 'cache_bootstrap');
  3182. }
  3183. return;
  3184. }
  3185. // $type is either 'interface' or 'class', so we only need the first letter to
  3186. // keep the cache key unique.
  3187. $cache_key = $type[0] . $name;
  3188. if (isset($lookup_cache[$cache_key])) {
  3189. if ($lookup_cache[$cache_key]) {
  3190. include_once DRUPAL_ROOT . '/' . $lookup_cache[$cache_key];
  3191. }
  3192. return (bool) $lookup_cache[$cache_key];
  3193. }
  3194. // This function may get called when the default database is not active, but
  3195. // there is no reason we'd ever want to not use the default database for
  3196. // this query.
  3197. $file = Database::getConnection('default', 'default')
  3198. ->select('registry', 'r', array('target' => 'default'))
  3199. ->fields('r', array('filename'))
  3200. // Use LIKE here to make the query case-insensitive.
  3201. ->condition('r.name', db_like($name), 'LIKE')
  3202. ->condition('r.type', $type)
  3203. ->execute()
  3204. ->fetchField();
  3205. // Flag that we've run a lookup query and need to update the cache.
  3206. $cache_update_needed = TRUE;
  3207. // Misses are valuable information worth caching, so cache even if
  3208. // $file is FALSE.
  3209. $lookup_cache[$cache_key] = $file;
  3210. if ($file) {
  3211. include_once DRUPAL_ROOT . '/' . $file;
  3212. return TRUE;
  3213. }
  3214. else {
  3215. return FALSE;
  3216. }
  3217. }
  3218. /**
  3219. * Rescans all enabled modules and rebuilds the registry.
  3220. *
  3221. * Rescans all code in modules or includes directories, storing the location of
  3222. * each interface or class in the database.
  3223. */
  3224. function registry_rebuild() {
  3225. system_rebuild_module_data();
  3226. registry_update();
  3227. }
  3228. /**
  3229. * Updates the registry based on the latest files listed in the database.
  3230. *
  3231. * This function should be used when system_rebuild_module_data() does not need
  3232. * to be called, because it is already known that the list of files in the
  3233. * {system} table matches those in the file system.
  3234. *
  3235. * @return
  3236. * TRUE if the registry was rebuilt, FALSE if another thread was rebuilding
  3237. * in parallel and the current thread just waited for completion.
  3238. *
  3239. * @see registry_rebuild()
  3240. */
  3241. function registry_update() {
  3242. // install_system_module() calls module_enable() which calls into this
  3243. // function during initial system installation, so the lock system is neither
  3244. // loaded nor does its storage exist yet.
  3245. $in_installer = drupal_installation_attempted();
  3246. if (!$in_installer && !lock_acquire(__FUNCTION__)) {
  3247. // Another request got the lock, wait for it to finish.
  3248. lock_wait(__FUNCTION__);
  3249. return FALSE;
  3250. }
  3251. require_once DRUPAL_ROOT . '/includes/registry.inc';
  3252. _registry_update();
  3253. if (!$in_installer) {
  3254. lock_release(__FUNCTION__);
  3255. }
  3256. return TRUE;
  3257. }
  3258. /**
  3259. * @} End of "addtogroup registry".
  3260. */
  3261. /**
  3262. * Provides central static variable storage.
  3263. *
  3264. * All functions requiring a static variable to persist or cache data within
  3265. * a single page request are encouraged to use this function unless it is
  3266. * absolutely certain that the static variable will not need to be reset during
  3267. * the page request. By centralizing static variable storage through this
  3268. * function, other functions can rely on a consistent API for resetting any
  3269. * other function's static variables.
  3270. *
  3271. * Example:
  3272. * @code
  3273. * function language_list($field = 'language') {
  3274. * $languages = &drupal_static(__FUNCTION__);
  3275. * if (!isset($languages)) {
  3276. * // If this function is being called for the first time after a reset,
  3277. * // query the database and execute any other code needed to retrieve
  3278. * // information about the supported languages.
  3279. * ...
  3280. * }
  3281. * if (!isset($languages[$field])) {
  3282. * // If this function is being called for the first time for a particular
  3283. * // index field, then execute code needed to index the information already
  3284. * // available in $languages by the desired field.
  3285. * ...
  3286. * }
  3287. * // Subsequent invocations of this function for a particular index field
  3288. * // skip the above two code blocks and quickly return the already indexed
  3289. * // information.
  3290. * return $languages[$field];
  3291. * }
  3292. * function locale_translate_overview_screen() {
  3293. * // When building the content for the translations overview page, make
  3294. * // sure to get completely fresh information about the supported languages.
  3295. * drupal_static_reset('language_list');
  3296. * ...
  3297. * }
  3298. * @endcode
  3299. *
  3300. * In a few cases, a function can have certainty that there is no legitimate
  3301. * use-case for resetting that function's static variable. This is rare,
  3302. * because when writing a function, it's hard to forecast all the situations in
  3303. * which it will be used. A guideline is that if a function's static variable
  3304. * does not depend on any information outside of the function that might change
  3305. * during a single page request, then it's ok to use the "static" keyword
  3306. * instead of the drupal_static() function.
  3307. *
  3308. * Example:
  3309. * @code
  3310. * function actions_do(...) {
  3311. * // $stack tracks the number of recursive calls.
  3312. * static $stack;
  3313. * $stack++;
  3314. * if ($stack > variable_get('actions_max_stack', 35)) {
  3315. * ...
  3316. * return;
  3317. * }
  3318. * ...
  3319. * $stack--;
  3320. * }
  3321. * @endcode
  3322. *
  3323. * In a few cases, a function needs a resettable static variable, but the
  3324. * function is called many times (100+) during a single page request, so
  3325. * every microsecond of execution time that can be removed from the function
  3326. * counts. These functions can use a more cumbersome, but faster variant of
  3327. * calling drupal_static(). It works by storing the reference returned by
  3328. * drupal_static() in the calling function's own static variable, thereby
  3329. * removing the need to call drupal_static() for each iteration of the function.
  3330. * Conceptually, it replaces:
  3331. * @code
  3332. * $foo = &drupal_static(__FUNCTION__);
  3333. * @endcode
  3334. * with:
  3335. * @code
  3336. * // Unfortunately, this does not work.
  3337. * static $foo = &drupal_static(__FUNCTION__);
  3338. * @endcode
  3339. * However, the above line of code does not work, because PHP only allows static
  3340. * variables to be initializied by literal values, and does not allow static
  3341. * variables to be assigned to references.
  3342. * - http://php.net/manual/language.variables.scope.php#language.variables.scope.static
  3343. * - http://php.net/manual/language.variables.scope.php#language.variables.scope.references
  3344. * The example below shows the syntax needed to work around both limitations.
  3345. * For benchmarks and more information, see http://drupal.org/node/619666.
  3346. *
  3347. * Example:
  3348. * @code
  3349. * function user_access($string, $account = NULL) {
  3350. * // Use the advanced drupal_static() pattern, since this is called very often.
  3351. * static $drupal_static_fast;
  3352. * if (!isset($drupal_static_fast)) {
  3353. * $drupal_static_fast['perm'] = &drupal_static(__FUNCTION__);
  3354. * }
  3355. * $perm = &$drupal_static_fast['perm'];
  3356. * ...
  3357. * }
  3358. * @endcode
  3359. *
  3360. * @param $name
  3361. * Globally unique name for the variable. For a function with only one static,
  3362. * variable, the function name (e.g. via the PHP magic __FUNCTION__ constant)
  3363. * is recommended. For a function with multiple static variables add a
  3364. * distinguishing suffix to the function name for each one.
  3365. * @param $default_value
  3366. * Optional default value.
  3367. * @param $reset
  3368. * TRUE to reset one or all variables(s). This parameter is only used
  3369. * internally and should not be passed in; use drupal_static_reset() instead.
  3370. * (This function's return value should not be used when TRUE is passed in.)
  3371. *
  3372. * @return
  3373. * Returns a variable by reference.
  3374. *
  3375. * @see drupal_static_reset()
  3376. */
  3377. function &drupal_static($name, $default_value = NULL, $reset = FALSE) {
  3378. static $data = array(), $default = array();
  3379. // First check if dealing with a previously defined static variable.
  3380. if (isset($data[$name]) || array_key_exists($name, $data)) {
  3381. // Non-NULL $name and both $data[$name] and $default[$name] statics exist.
  3382. if ($reset) {
  3383. // Reset pre-existing static variable to its default value.
  3384. $data[$name] = $default[$name];
  3385. }
  3386. return $data[$name];
  3387. }
  3388. // Neither $data[$name] nor $default[$name] static variables exist.
  3389. if (isset($name)) {
  3390. if ($reset) {
  3391. // Reset was called before a default is set and yet a variable must be
  3392. // returned.
  3393. return $data;
  3394. }
  3395. // First call with new non-NULL $name. Initialize a new static variable.
  3396. $default[$name] = $data[$name] = $default_value;
  3397. return $data[$name];
  3398. }
  3399. // Reset all: ($name == NULL). This needs to be done one at a time so that
  3400. // references returned by earlier invocations of drupal_static() also get
  3401. // reset.
  3402. foreach ($default as $name => $value) {
  3403. $data[$name] = $value;
  3404. }
  3405. // As the function returns a reference, the return should always be a
  3406. // variable.
  3407. return $data;
  3408. }
  3409. /**
  3410. * Resets one or all centrally stored static variable(s).
  3411. *
  3412. * @param $name
  3413. * Name of the static variable to reset. Omit to reset all variables.
  3414. * Resetting all variables should only be used, for example, for running unit
  3415. * tests with a clean environment.
  3416. */
  3417. function drupal_static_reset($name = NULL) {
  3418. drupal_static($name, NULL, TRUE);
  3419. }
  3420. /**
  3421. * Detects whether the current script is running in a command-line environment.
  3422. */
  3423. function drupal_is_cli() {
  3424. return (!isset($_SERVER['SERVER_SOFTWARE']) && (php_sapi_name() == 'cli' || (is_numeric($_SERVER['argc']) && $_SERVER['argc'] > 0)));
  3425. }
  3426. /**
  3427. * Formats text for emphasized display in a placeholder inside a sentence.
  3428. *
  3429. * Used automatically by format_string().
  3430. *
  3431. * @param $text
  3432. * The text to format (plain-text).
  3433. *
  3434. * @return
  3435. * The formatted text (html).
  3436. */
  3437. function drupal_placeholder($text) {
  3438. return '<em class="placeholder">' . check_plain($text) . '</em>';
  3439. }
  3440. /**
  3441. * Registers a function for execution on shutdown.
  3442. *
  3443. * Wrapper for register_shutdown_function() that catches thrown exceptions to
  3444. * avoid "Exception thrown without a stack frame in Unknown".
  3445. *
  3446. * @param $callback
  3447. * The shutdown function to register.
  3448. * @param ...
  3449. * Additional arguments to pass to the shutdown function.
  3450. *
  3451. * @return
  3452. * Array of shutdown functions to be executed.
  3453. *
  3454. * @see register_shutdown_function()
  3455. * @ingroup php_wrappers
  3456. */
  3457. function &drupal_register_shutdown_function($callback = NULL) {
  3458. // We cannot use drupal_static() here because the static cache is reset during
  3459. // batch processing, which breaks batch handling.
  3460. static $callbacks = array();
  3461. if (isset($callback)) {
  3462. // Only register the internal shutdown function once.
  3463. if (empty($callbacks)) {
  3464. register_shutdown_function('_drupal_shutdown_function');
  3465. }
  3466. $args = func_get_args();
  3467. array_shift($args);
  3468. // Save callback and arguments
  3469. $callbacks[] = array('callback' => $callback, 'arguments' => $args);
  3470. }
  3471. return $callbacks;
  3472. }
  3473. /**
  3474. * Executes registered shutdown functions.
  3475. */
  3476. function _drupal_shutdown_function() {
  3477. $callbacks = &drupal_register_shutdown_function();
  3478. // Set the CWD to DRUPAL_ROOT as it is not guaranteed to be the same as it
  3479. // was in the normal context of execution.
  3480. chdir(DRUPAL_ROOT);
  3481. try {
  3482. // Manually iterate over the array instead of using a foreach loop.
  3483. // A foreach operates on a copy of the array, so any shutdown functions that
  3484. // were added from other shutdown functions would never be called.
  3485. while ($callback = current($callbacks)) {
  3486. call_user_func_array($callback['callback'], $callback['arguments']);
  3487. next($callbacks);
  3488. }
  3489. }
  3490. catch (Exception $exception) {
  3491. // If we are displaying errors, then do so with no possibility of a further uncaught exception being thrown.
  3492. require_once DRUPAL_ROOT . '/includes/errors.inc';
  3493. if (error_displayable()) {
  3494. print '<h1>Uncaught exception thrown in shutdown function.</h1>';
  3495. print '<p>' . _drupal_render_exception_safe($exception) . '</p><hr />';
  3496. }
  3497. }
  3498. }
  3499. /**
  3500. * Compares the memory required for an operation to the available memory.
  3501. *
  3502. * @param $required
  3503. * The memory required for the operation, expressed as a number of bytes with
  3504. * optional SI or IEC binary unit prefix (e.g. 2, 3K, 5MB, 10G, 6GiB, 8bytes,
  3505. * 9mbytes).
  3506. * @param $memory_limit
  3507. * (optional) The memory limit for the operation, expressed as a number of
  3508. * bytes with optional SI or IEC binary unit prefix (e.g. 2, 3K, 5MB, 10G,
  3509. * 6GiB, 8bytes, 9mbytes). If no value is passed, the current PHP
  3510. * memory_limit will be used. Defaults to NULL.
  3511. *
  3512. * @return
  3513. * TRUE if there is sufficient memory to allow the operation, or FALSE
  3514. * otherwise.
  3515. */
  3516. function drupal_check_memory_limit($required, $memory_limit = NULL) {
  3517. if (!isset($memory_limit)) {
  3518. $memory_limit = ini_get('memory_limit');
  3519. }
  3520. // There is sufficient memory if:
  3521. // - No memory limit is set.
  3522. // - The memory limit is set to unlimited (-1).
  3523. // - The memory limit is greater than the memory required for the operation.
  3524. return ((!$memory_limit) || ($memory_limit == -1) || (parse_size($memory_limit) >= parse_size($required)));
  3525. }
  3526. /**
  3527. * Invalidates a PHP file from any active opcode caches.
  3528. *
  3529. * If the opcode cache does not support the invalidation of individual files,
  3530. * the entire cache will be flushed.
  3531. *
  3532. * @param string $filepath
  3533. * The absolute path of the PHP file to invalidate.
  3534. */
  3535. function drupal_clear_opcode_cache($filepath) {
  3536. if (!defined('PHP_VERSION_ID') || PHP_VERSION_ID < 50300) {
  3537. // Below PHP 5.3, clearstatcache does not accept any function parameters.
  3538. clearstatcache();
  3539. }
  3540. else {
  3541. clearstatcache(TRUE, $filepath);
  3542. }
  3543. // Zend OPcache.
  3544. if (function_exists('opcache_invalidate')) {
  3545. opcache_invalidate($filepath, TRUE);
  3546. }
  3547. // APC.
  3548. if (function_exists('apc_delete_file')) {
  3549. // apc_delete_file() throws a PHP warning in case the specified file was
  3550. // not compiled yet.
  3551. // @see http://php.net/apc-delete-file
  3552. @apc_delete_file($filepath);
  3553. }
  3554. }