menu.inc 138 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951
  1. <?php
  2. /**
  3. * @file
  4. * API for the Drupal menu system.
  5. */
  6. /**
  7. * @defgroup menu Menu system
  8. * @{
  9. * Define the navigation menus, and route page requests to code based on URLs.
  10. *
  11. * The Drupal menu system drives both the navigation system from a user
  12. * perspective and the callback system that Drupal uses to respond to URLs
  13. * passed from the browser. For this reason, a good understanding of the
  14. * menu system is fundamental to the creation of complex modules. As a note,
  15. * this is related to, but separate from menu.module, which allows menus
  16. * (which in this context are hierarchical lists of links) to be customized from
  17. * the Drupal administrative interface.
  18. *
  19. * Drupal's menu system follows a simple hierarchy defined by paths.
  20. * Implementations of hook_menu() define menu items and assign them to
  21. * paths (which should be unique). The menu system aggregates these items
  22. * and determines the menu hierarchy from the paths. For example, if the
  23. * paths defined were a, a/b, e, a/b/c/d, f/g, and a/b/h, the menu system
  24. * would form the structure:
  25. * - a
  26. * - a/b
  27. * - a/b/c/d
  28. * - a/b/h
  29. * - e
  30. * - f/g
  31. * Note that the number of elements in the path does not necessarily
  32. * determine the depth of the menu item in the tree.
  33. *
  34. * When responding to a page request, the menu system looks to see if the
  35. * path requested by the browser is registered as a menu item with a
  36. * callback. If not, the system searches up the menu tree for the most
  37. * complete match with a callback it can find. If the path a/b/i is
  38. * requested in the tree above, the callback for a/b would be used.
  39. *
  40. * The found callback function is called with any arguments specified
  41. * in the "page arguments" attribute of its menu item. The
  42. * attribute must be an array. After these arguments, any remaining
  43. * components of the path are appended as further arguments. In this
  44. * way, the callback for a/b above could respond to a request for
  45. * a/b/i differently than a request for a/b/j.
  46. *
  47. * For an illustration of this process, see page_example.module.
  48. *
  49. * Access to the callback functions is also protected by the menu system.
  50. * The "access callback" with an optional "access arguments" of each menu
  51. * item is called before the page callback proceeds. If this returns TRUE,
  52. * then access is granted; if FALSE, then access is denied. Default local task
  53. * menu items (see next paragraph) may omit this attribute to use the value
  54. * provided by the parent item.
  55. *
  56. * In the default Drupal interface, you will notice many links rendered as
  57. * tabs. These are known in the menu system as "local tasks", and they are
  58. * rendered as tabs by default, though other presentations are possible.
  59. * Local tasks function just as other menu items in most respects. It is
  60. * convention that the names of these tasks should be short verbs if
  61. * possible. In addition, a "default" local task should be provided for
  62. * each set. When visiting a local task's parent menu item, the default
  63. * local task will be rendered as if it is selected; this provides for a
  64. * normal tab user experience. This default task is special in that it
  65. * links not to its provided path, but to its parent item's path instead.
  66. * The default task's path is only used to place it appropriately in the
  67. * menu hierarchy.
  68. *
  69. * Everything described so far is stored in the menu_router table. The
  70. * menu_links table holds the visible menu links. By default these are
  71. * derived from the same hook_menu definitions, however you are free to
  72. * add more with menu_link_save().
  73. */
  74. /**
  75. * @defgroup menu_flags Menu flags
  76. * @{
  77. * Flags for use in the "type" attribute of menu items.
  78. */
  79. /**
  80. * Internal menu flag -- menu item is the root of the menu tree.
  81. */
  82. define('MENU_IS_ROOT', 0x0001);
  83. /**
  84. * Internal menu flag -- menu item is visible in the menu tree.
  85. */
  86. define('MENU_VISIBLE_IN_TREE', 0x0002);
  87. /**
  88. * Internal menu flag -- menu item is visible in the breadcrumb.
  89. */
  90. define('MENU_VISIBLE_IN_BREADCRUMB', 0x0004);
  91. /**
  92. * Internal menu flag -- menu item links back to its parent.
  93. */
  94. define('MENU_LINKS_TO_PARENT', 0x0008);
  95. /**
  96. * Internal menu flag -- menu item can be modified by administrator.
  97. */
  98. define('MENU_MODIFIED_BY_ADMIN', 0x0020);
  99. /**
  100. * Internal menu flag -- menu item was created by administrator.
  101. */
  102. define('MENU_CREATED_BY_ADMIN', 0x0040);
  103. /**
  104. * Internal menu flag -- menu item is a local task.
  105. */
  106. define('MENU_IS_LOCAL_TASK', 0x0080);
  107. /**
  108. * Internal menu flag -- menu item is a local action.
  109. */
  110. define('MENU_IS_LOCAL_ACTION', 0x0100);
  111. /**
  112. * @} End of "Menu flags".
  113. */
  114. /**
  115. * @defgroup menu_item_types Menu item types
  116. * @{
  117. * Definitions for various menu item types.
  118. *
  119. * Menu item definitions provide one of these constants, which are shortcuts for
  120. * combinations of @link menu_flags Menu flags @endlink.
  121. */
  122. /**
  123. * Menu type -- A "normal" menu item that's shown in menu and breadcrumbs.
  124. *
  125. * Normal menu items show up in the menu tree and can be moved/hidden by
  126. * the administrator. Use this for most menu items. It is the default value if
  127. * no menu item type is specified.
  128. */
  129. define('MENU_NORMAL_ITEM', MENU_VISIBLE_IN_TREE | MENU_VISIBLE_IN_BREADCRUMB);
  130. /**
  131. * Menu type -- A hidden, internal callback, typically used for API calls.
  132. *
  133. * Callbacks simply register a path so that the correct function is fired
  134. * when the URL is accessed. They do not appear in menus or breadcrumbs.
  135. */
  136. define('MENU_CALLBACK', 0x0000);
  137. /**
  138. * Menu type -- A normal menu item, hidden until enabled by an administrator.
  139. *
  140. * Modules may "suggest" menu items that the administrator may enable. They act
  141. * just as callbacks do until enabled, at which time they act like normal items.
  142. * Note for the value: 0x0010 was a flag which is no longer used, but this way
  143. * the values of MENU_CALLBACK and MENU_SUGGESTED_ITEM are separate.
  144. */
  145. define('MENU_SUGGESTED_ITEM', MENU_VISIBLE_IN_BREADCRUMB | 0x0010);
  146. /**
  147. * Menu type -- A task specific to the parent item, usually rendered as a tab.
  148. *
  149. * Local tasks are menu items that describe actions to be performed on their
  150. * parent item. An example is the path "node/52/edit", which performs the
  151. * "edit" task on "node/52".
  152. */
  153. define('MENU_LOCAL_TASK', MENU_IS_LOCAL_TASK | MENU_VISIBLE_IN_BREADCRUMB);
  154. /**
  155. * Menu type -- The "default" local task, which is initially active.
  156. *
  157. * Every set of local tasks should provide one "default" task, that links to the
  158. * same path as its parent when clicked.
  159. */
  160. define('MENU_DEFAULT_LOCAL_TASK', MENU_IS_LOCAL_TASK | MENU_LINKS_TO_PARENT | MENU_VISIBLE_IN_BREADCRUMB);
  161. /**
  162. * Menu type -- An action specific to the parent, usually rendered as a link.
  163. *
  164. * Local actions are menu items that describe actions on the parent item such
  165. * as adding a new user, taxonomy term, etc.
  166. */
  167. define('MENU_LOCAL_ACTION', MENU_IS_LOCAL_TASK | MENU_IS_LOCAL_ACTION | MENU_VISIBLE_IN_BREADCRUMB);
  168. /**
  169. * @} End of "Menu item types".
  170. */
  171. /**
  172. * @defgroup menu_context_types Menu context types
  173. * @{
  174. * Flags for use in the "context" attribute of menu router items.
  175. */
  176. /**
  177. * Internal menu flag: Invisible local task.
  178. *
  179. * This flag may be used for local tasks like "Delete", so custom modules and
  180. * themes can alter the default context and expose the task by altering menu.
  181. */
  182. define('MENU_CONTEXT_NONE', 0x0000);
  183. /**
  184. * Internal menu flag: Local task should be displayed in page context.
  185. */
  186. define('MENU_CONTEXT_PAGE', 0x0001);
  187. /**
  188. * Internal menu flag: Local task should be displayed inline.
  189. */
  190. define('MENU_CONTEXT_INLINE', 0x0002);
  191. /**
  192. * @} End of "Menu context types".
  193. */
  194. /**
  195. * @defgroup menu_status_codes Menu status codes
  196. * @{
  197. * Status codes for menu callbacks.
  198. */
  199. /**
  200. * Internal menu status code -- Menu item was found.
  201. */
  202. define('MENU_FOUND', 1);
  203. /**
  204. * Menu status code -- Not found.
  205. *
  206. * This can be used as the return value from a page callback, although it is
  207. * preferable to use a load function to accomplish this; see the hook_menu()
  208. * documentation for details.
  209. */
  210. define('MENU_NOT_FOUND', 2);
  211. /**
  212. * Menu status code -- Access denied.
  213. *
  214. * This can be used as the return value from a page callback, although it is
  215. * preferable to use an access callback to accomplish this; see the hook_menu()
  216. * documentation for details.
  217. */
  218. define('MENU_ACCESS_DENIED', 3);
  219. /**
  220. * Internal menu status code -- Menu item inaccessible because site is offline.
  221. */
  222. define('MENU_SITE_OFFLINE', 4);
  223. /**
  224. * Internal menu status code -- Everything is working fine.
  225. */
  226. define('MENU_SITE_ONLINE', 5);
  227. /**
  228. * @} End of "Menu status codes".
  229. */
  230. /**
  231. * @defgroup menu_tree_parameters Menu tree parameters
  232. * @{
  233. * Parameters for a menu tree.
  234. */
  235. /**
  236. * The maximum number of path elements for a menu callback
  237. */
  238. define('MENU_MAX_PARTS', 9);
  239. /**
  240. * The maximum depth of a menu links tree - matches the number of p columns.
  241. */
  242. define('MENU_MAX_DEPTH', 9);
  243. /**
  244. * @} End of "Menu tree parameters".
  245. */
  246. /**
  247. * Reserved key to identify the most specific menu link for a given path.
  248. *
  249. * The value of this constant is a hash of the constant name. We use the hash
  250. * so that the reserved key is over 32 characters in length and will not
  251. * collide with allowed menu names:
  252. * @code
  253. * sha1('MENU_PREFERRED_LINK') = 1cf698d64d1aa4b83907cf6ed55db3a7f8e92c91
  254. * @endcode
  255. *
  256. * @see menu_link_get_preferred()
  257. */
  258. define('MENU_PREFERRED_LINK', '1cf698d64d1aa4b83907cf6ed55db3a7f8e92c91');
  259. /**
  260. * Returns the ancestors (and relevant placeholders) for any given path.
  261. *
  262. * For example, the ancestors of node/12345/edit are:
  263. * - node/12345/edit
  264. * - node/12345/%
  265. * - node/%/edit
  266. * - node/%/%
  267. * - node/12345
  268. * - node/%
  269. * - node
  270. *
  271. * To generate these, we will use binary numbers. Each bit represents a
  272. * part of the path. If the bit is 1, then it represents the original
  273. * value while 0 means wildcard. If the path is node/12/edit/foo
  274. * then the 1011 bitstring represents node/%/edit/foo where % means that
  275. * any argument matches that part. We limit ourselves to using binary
  276. * numbers that correspond the patterns of wildcards of router items that
  277. * actually exists. This list of 'masks' is built in menu_rebuild().
  278. *
  279. * @param $parts
  280. * An array of path parts; for the above example,
  281. * array('node', '12345', 'edit').
  282. *
  283. * @return
  284. * An array which contains the ancestors and placeholders. Placeholders
  285. * simply contain as many '%s' as the ancestors.
  286. */
  287. function menu_get_ancestors($parts) {
  288. $number_parts = count($parts);
  289. $ancestors = array();
  290. $length = $number_parts - 1;
  291. $end = (1 << $number_parts) - 1;
  292. $masks = variable_get('menu_masks');
  293. // If the optimized menu_masks array is not available use brute force to get
  294. // the correct $ancestors and $placeholders returned. Do not use this as the
  295. // default value of the menu_masks variable to avoid building such a big
  296. // array.
  297. if (!$masks) {
  298. $masks = range(511, 1);
  299. }
  300. // Only examine patterns that actually exist as router items (the masks).
  301. foreach ($masks as $i) {
  302. if ($i > $end) {
  303. // Only look at masks that are not longer than the path of interest.
  304. continue;
  305. }
  306. elseif ($i < (1 << $length)) {
  307. // We have exhausted the masks of a given length, so decrease the length.
  308. --$length;
  309. }
  310. $current = '';
  311. for ($j = $length; $j >= 0; $j--) {
  312. // Check the bit on the $j offset.
  313. if ($i & (1 << $j)) {
  314. // Bit one means the original value.
  315. $current .= $parts[$length - $j];
  316. }
  317. else {
  318. // Bit zero means means wildcard.
  319. $current .= '%';
  320. }
  321. // Unless we are at offset 0, add a slash.
  322. if ($j) {
  323. $current .= '/';
  324. }
  325. }
  326. $ancestors[] = $current;
  327. }
  328. return $ancestors;
  329. }
  330. /**
  331. * Unserializes menu data, using a map to replace path elements.
  332. *
  333. * The menu system stores various path-related information (such as the 'page
  334. * arguments' and 'access arguments' components of a menu item) in the database
  335. * using serialized arrays, where integer values in the arrays represent
  336. * arguments to be replaced by values from the path. This function first
  337. * unserializes such menu information arrays, and then does the path
  338. * replacement.
  339. *
  340. * The path replacement acts on each integer-valued element of the unserialized
  341. * menu data array ($data) using a map array ($map, which is typically an array
  342. * of path arguments) as a list of replacements. For instance, if there is an
  343. * element of $data whose value is the number 2, then it is replaced in $data
  344. * with $map[2]; non-integer values in $data are left alone.
  345. *
  346. * As an example, an unserialized $data array with elements ('node_load', 1)
  347. * represents instructions for calling the node_load() function. Specifically,
  348. * this instruction says to use the path component at index 1 as the input
  349. * parameter to node_load(). If the path is 'node/123', then $map will be the
  350. * array ('node', 123), and the returned array from this function will have
  351. * elements ('node_load', 123), since $map[1] is 123. This return value will
  352. * indicate specifically that node_load(123) is to be called to load the node
  353. * whose ID is 123 for this menu item.
  354. *
  355. * @param $data
  356. * A serialized array of menu data, as read from the database.
  357. * @param $map
  358. * A path argument array, used to replace integer values in $data; an integer
  359. * value N in $data will be replaced by value $map[N]. Typically, the $map
  360. * array is generated from a call to the arg() function.
  361. *
  362. * @return
  363. * The unserialized $data array, with path arguments replaced.
  364. */
  365. function menu_unserialize($data, $map) {
  366. if ($data = unserialize($data)) {
  367. foreach ($data as $k => $v) {
  368. if (is_int($v)) {
  369. $data[$k] = isset($map[$v]) ? $map[$v] : '';
  370. }
  371. }
  372. return $data;
  373. }
  374. else {
  375. return array();
  376. }
  377. }
  378. /**
  379. * Replaces the statically cached item for a given path.
  380. *
  381. * @param $path
  382. * The path.
  383. * @param $router_item
  384. * The router item. Usually a router entry from menu_get_item() is either
  385. * modified or set to a different path. This allows the navigation block,
  386. * the page title, the breadcrumb, and the page help to be modified in one
  387. * call.
  388. */
  389. function menu_set_item($path, $router_item) {
  390. menu_get_item($path, $router_item);
  391. }
  392. /**
  393. * Gets a router item.
  394. *
  395. * @param $path
  396. * The path; for example, 'node/5'. The function will find the corresponding
  397. * node/% item and return that. Defaults to the current path.
  398. * @param $router_item
  399. * Internal use only.
  400. *
  401. * @return
  402. * The router item or, if an error occurs in _menu_translate(), FALSE. A
  403. * router item is an associative array corresponding to one row in the
  404. * menu_router table. The value corresponding to the key 'map' holds the
  405. * loaded objects. The value corresponding to the key 'access' is TRUE if the
  406. * current user can access this page. The values corresponding to the keys
  407. * 'title', 'page_arguments', 'access_arguments', and 'theme_arguments' will
  408. * be filled in based on the database values and the objects loaded.
  409. */
  410. function menu_get_item($path = NULL, $router_item = NULL) {
  411. $router_items = &drupal_static(__FUNCTION__);
  412. if (!isset($path)) {
  413. $path = $_GET['q'];
  414. }
  415. if (isset($router_item)) {
  416. $router_items[$path] = $router_item;
  417. }
  418. if (!isset($router_items[$path])) {
  419. // Rebuild if we know it's needed, or if the menu masks are missing which
  420. // occurs rarely, likely due to a race condition of multiple rebuilds.
  421. if (variable_get('menu_rebuild_needed', FALSE) || !variable_get('menu_masks', array())) {
  422. if (_menu_check_rebuild()) {
  423. menu_rebuild();
  424. }
  425. }
  426. $original_map = arg(NULL, $path);
  427. $parts = array_slice($original_map, 0, MENU_MAX_PARTS);
  428. $ancestors = menu_get_ancestors($parts);
  429. $router_item = db_query_range('SELECT * FROM {menu_router} WHERE path IN (:ancestors) ORDER BY fit DESC', 0, 1, array(':ancestors' => $ancestors))->fetchAssoc();
  430. if ($router_item) {
  431. // Allow modules to alter the router item before it is translated and
  432. // checked for access.
  433. drupal_alter('menu_get_item', $router_item, $path, $original_map);
  434. $map = _menu_translate($router_item, $original_map);
  435. $router_item['original_map'] = $original_map;
  436. if ($map === FALSE) {
  437. $router_items[$path] = FALSE;
  438. return FALSE;
  439. }
  440. if ($router_item['access']) {
  441. $router_item['map'] = $map;
  442. $router_item['page_arguments'] = array_merge(menu_unserialize($router_item['page_arguments'], $map), array_slice($map, $router_item['number_parts']));
  443. $router_item['theme_arguments'] = array_merge(menu_unserialize($router_item['theme_arguments'], $map), array_slice($map, $router_item['number_parts']));
  444. }
  445. }
  446. $router_items[$path] = $router_item;
  447. }
  448. return $router_items[$path];
  449. }
  450. /**
  451. * Execute the page callback associated with the current path.
  452. *
  453. * @param $path
  454. * The drupal path whose handler is to be be executed. If set to NULL, then
  455. * the current path is used.
  456. * @param $deliver
  457. * (optional) A boolean to indicate whether the content should be sent to the
  458. * browser using the appropriate delivery callback (TRUE) or whether to return
  459. * the result to the caller (FALSE).
  460. */
  461. function menu_execute_active_handler($path = NULL, $deliver = TRUE) {
  462. // Check if site is offline.
  463. $page_callback_result = _menu_site_is_offline() ? MENU_SITE_OFFLINE : MENU_SITE_ONLINE;
  464. // Allow other modules to change the site status but not the path because that
  465. // would not change the global variable. hook_url_inbound_alter() can be used
  466. // to change the path. Code later will not use the $read_only_path variable.
  467. $read_only_path = !empty($path) ? $path : $_GET['q'];
  468. drupal_alter('menu_site_status', $page_callback_result, $read_only_path);
  469. // Only continue if the site status is not set.
  470. if ($page_callback_result == MENU_SITE_ONLINE) {
  471. if ($router_item = menu_get_item($path)) {
  472. if ($router_item['access']) {
  473. if ($router_item['include_file']) {
  474. require_once DRUPAL_ROOT . '/' . $router_item['include_file'];
  475. }
  476. $page_callback_result = call_user_func_array($router_item['page_callback'], $router_item['page_arguments']);
  477. }
  478. else {
  479. $page_callback_result = MENU_ACCESS_DENIED;
  480. }
  481. }
  482. else {
  483. $page_callback_result = MENU_NOT_FOUND;
  484. }
  485. }
  486. // Deliver the result of the page callback to the browser, or if requested,
  487. // return it raw, so calling code can do more processing.
  488. if ($deliver) {
  489. $default_delivery_callback = (isset($router_item) && $router_item) ? $router_item['delivery_callback'] : NULL;
  490. drupal_deliver_page($page_callback_result, $default_delivery_callback);
  491. }
  492. else {
  493. return $page_callback_result;
  494. }
  495. }
  496. /**
  497. * Loads objects into the map as defined in the $item['load_functions'].
  498. *
  499. * @param $item
  500. * A menu router or menu link item
  501. * @param $map
  502. * An array of path arguments; for example, array('node', '5').
  503. *
  504. * @return
  505. * Returns TRUE for success, FALSE if an object cannot be loaded.
  506. * Names of object loading functions are placed in $item['load_functions'].
  507. * Loaded objects are placed in $map[]; keys are the same as keys in the
  508. * $item['load_functions'] array.
  509. * $item['access'] is set to FALSE if an object cannot be loaded.
  510. */
  511. function _menu_load_objects(&$item, &$map) {
  512. if ($load_functions = $item['load_functions']) {
  513. // If someone calls this function twice, then unserialize will fail.
  514. if (!is_array($load_functions)) {
  515. $load_functions = unserialize($load_functions);
  516. }
  517. $path_map = $map;
  518. foreach ($load_functions as $index => $function) {
  519. if ($function) {
  520. $value = isset($path_map[$index]) ? $path_map[$index] : '';
  521. if (is_array($function)) {
  522. // Set up arguments for the load function. These were pulled from
  523. // 'load arguments' in the hook_menu() entry, but they need
  524. // some processing. In this case the $function is the key to the
  525. // load_function array, and the value is the list of arguments.
  526. list($function, $args) = each($function);
  527. $load_functions[$index] = $function;
  528. // Some arguments are placeholders for dynamic items to process.
  529. foreach ($args as $i => $arg) {
  530. if ($arg === '%index') {
  531. // Pass on argument index to the load function, so multiple
  532. // occurrences of the same placeholder can be identified.
  533. $args[$i] = $index;
  534. }
  535. if ($arg === '%map') {
  536. // Pass on menu map by reference. The accepting function must
  537. // also declare this as a reference if it wants to modify
  538. // the map.
  539. $args[$i] = &$map;
  540. }
  541. if (is_int($arg)) {
  542. $args[$i] = isset($path_map[$arg]) ? $path_map[$arg] : '';
  543. }
  544. }
  545. array_unshift($args, $value);
  546. $return = call_user_func_array($function, $args);
  547. }
  548. else {
  549. $return = $function($value);
  550. }
  551. // If callback returned an error or there is no callback, trigger 404.
  552. if ($return === FALSE) {
  553. $item['access'] = FALSE;
  554. $map = FALSE;
  555. return FALSE;
  556. }
  557. $map[$index] = $return;
  558. }
  559. }
  560. $item['load_functions'] = $load_functions;
  561. }
  562. return TRUE;
  563. }
  564. /**
  565. * Checks access to a menu item using the access callback.
  566. *
  567. * @param $item
  568. * A menu router or menu link item
  569. * @param $map
  570. * An array of path arguments; for example, array('node', '5').
  571. *
  572. * @return
  573. * $item['access'] becomes TRUE if the item is accessible, FALSE otherwise.
  574. */
  575. function _menu_check_access(&$item, $map) {
  576. $item['access'] = FALSE;
  577. // Determine access callback, which will decide whether or not the current
  578. // user has access to this path.
  579. $callback = empty($item['access_callback']) ? 0 : trim($item['access_callback']);
  580. // Check for a TRUE or FALSE value.
  581. if (is_numeric($callback)) {
  582. $item['access'] = (bool) $callback;
  583. }
  584. else {
  585. $arguments = menu_unserialize($item['access_arguments'], $map);
  586. // As call_user_func_array is quite slow and user_access is a very common
  587. // callback, it is worth making a special case for it.
  588. if ($callback == 'user_access') {
  589. $item['access'] = (count($arguments) == 1) ? user_access($arguments[0]) : user_access($arguments[0], $arguments[1]);
  590. }
  591. elseif (function_exists($callback)) {
  592. $item['access'] = call_user_func_array($callback, $arguments);
  593. }
  594. }
  595. }
  596. /**
  597. * Localizes the router item title using t() or another callback.
  598. *
  599. * Translate the title and description to allow storage of English title
  600. * strings in the database, yet display of them in the language required
  601. * by the current user.
  602. *
  603. * @param $item
  604. * A menu router item or a menu link item.
  605. * @param $map
  606. * The path as an array with objects already replaced. E.g., for path
  607. * node/123 $map would be array('node', $node) where $node is the node
  608. * object for node 123.
  609. * @param $link_translate
  610. * TRUE if we are translating a menu link item; FALSE if we are
  611. * translating a menu router item.
  612. *
  613. * @return
  614. * No return value.
  615. * $item['title'] is localized according to $item['title_callback'].
  616. * If an item's callback is check_plain(), $item['options']['html'] becomes
  617. * TRUE.
  618. * $item['description'] is translated using t().
  619. * When doing link translation and the $item['options']['attributes']['title']
  620. * (link title attribute) matches the description, it is translated as well.
  621. */
  622. function _menu_item_localize(&$item, $map, $link_translate = FALSE) {
  623. $callback = $item['title_callback'];
  624. $item['localized_options'] = $item['options'];
  625. // All 'class' attributes are assumed to be an array during rendering, but
  626. // links stored in the database may use an old string value.
  627. // @todo In order to remove this code we need to implement a database update
  628. // including unserializing all existing link options and running this code
  629. // on them, as well as adding validation to menu_link_save().
  630. if (isset($item['options']['attributes']['class']) && is_string($item['options']['attributes']['class'])) {
  631. $item['localized_options']['attributes']['class'] = explode(' ', $item['options']['attributes']['class']);
  632. }
  633. // If we are translating the title of a menu link, and its title is the same
  634. // as the corresponding router item, then we can use the title information
  635. // from the router. If it's customized, then we need to use the link title
  636. // itself; can't localize.
  637. // If we are translating a router item (tabs, page, breadcrumb), then we
  638. // can always use the information from the router item.
  639. if (!$link_translate || ($item['title'] == $item['link_title'])) {
  640. // t() is a special case. Since it is used very close to all the time,
  641. // we handle it directly instead of using indirect, slower methods.
  642. if ($callback == 't') {
  643. if (empty($item['title_arguments'])) {
  644. $item['title'] = t($item['title']);
  645. }
  646. else {
  647. $item['title'] = t($item['title'], menu_unserialize($item['title_arguments'], $map));
  648. }
  649. }
  650. elseif ($callback && function_exists($callback)) {
  651. if (empty($item['title_arguments'])) {
  652. $item['title'] = $callback($item['title']);
  653. }
  654. else {
  655. $item['title'] = call_user_func_array($callback, menu_unserialize($item['title_arguments'], $map));
  656. }
  657. // Avoid calling check_plain again on l() function.
  658. if ($callback == 'check_plain') {
  659. $item['localized_options']['html'] = TRUE;
  660. }
  661. }
  662. }
  663. elseif ($link_translate) {
  664. $item['title'] = $item['link_title'];
  665. }
  666. // Translate description, see the motivation above.
  667. if (!empty($item['description'])) {
  668. $original_description = $item['description'];
  669. $item['description'] = t($item['description']);
  670. if ($link_translate && isset($item['options']['attributes']['title']) && $item['options']['attributes']['title'] == $original_description) {
  671. $item['localized_options']['attributes']['title'] = $item['description'];
  672. }
  673. }
  674. }
  675. /**
  676. * Handles dynamic path translation and menu access control.
  677. *
  678. * When a user arrives on a page such as node/5, this function determines
  679. * what "5" corresponds to, by inspecting the page's menu path definition,
  680. * node/%node. This will call node_load(5) to load the corresponding node
  681. * object.
  682. *
  683. * It also works in reverse, to allow the display of tabs and menu items which
  684. * contain these dynamic arguments, translating node/%node to node/5.
  685. *
  686. * Translation of menu item titles and descriptions are done here to
  687. * allow for storage of English strings in the database, and translation
  688. * to the language required to generate the current page.
  689. *
  690. * @param $router_item
  691. * A menu router item
  692. * @param $map
  693. * An array of path arguments; for example, array('node', '5').
  694. * @param $to_arg
  695. * Execute $item['to_arg_functions'] or not. Use only if you want to render a
  696. * path from the menu table, for example tabs.
  697. *
  698. * @return
  699. * Returns the map with objects loaded as defined in the
  700. * $item['load_functions']. $item['access'] becomes TRUE if the item is
  701. * accessible, FALSE otherwise. $item['href'] is set according to the map.
  702. * If an error occurs during calling the load_functions (like trying to load
  703. * a non-existent node) then this function returns FALSE.
  704. */
  705. function _menu_translate(&$router_item, $map, $to_arg = FALSE) {
  706. if ($to_arg && !empty($router_item['to_arg_functions'])) {
  707. // Fill in missing path elements, such as the current uid.
  708. _menu_link_map_translate($map, $router_item['to_arg_functions']);
  709. }
  710. // The $path_map saves the pieces of the path as strings, while elements in
  711. // $map may be replaced with loaded objects.
  712. $path_map = $map;
  713. if (!empty($router_item['load_functions']) && !_menu_load_objects($router_item, $map)) {
  714. // An error occurred loading an object.
  715. $router_item['access'] = FALSE;
  716. return FALSE;
  717. }
  718. // Generate the link path for the page request or local tasks.
  719. $link_map = explode('/', $router_item['path']);
  720. if (isset($router_item['tab_root'])) {
  721. $tab_root_map = explode('/', $router_item['tab_root']);
  722. }
  723. if (isset($router_item['tab_parent'])) {
  724. $tab_parent_map = explode('/', $router_item['tab_parent']);
  725. }
  726. for ($i = 0; $i < $router_item['number_parts']; $i++) {
  727. if ($link_map[$i] == '%') {
  728. $link_map[$i] = $path_map[$i];
  729. }
  730. if (isset($tab_root_map[$i]) && $tab_root_map[$i] == '%') {
  731. $tab_root_map[$i] = $path_map[$i];
  732. }
  733. if (isset($tab_parent_map[$i]) && $tab_parent_map[$i] == '%') {
  734. $tab_parent_map[$i] = $path_map[$i];
  735. }
  736. }
  737. $router_item['href'] = implode('/', $link_map);
  738. $router_item['tab_root_href'] = implode('/', $tab_root_map);
  739. $router_item['tab_parent_href'] = implode('/', $tab_parent_map);
  740. $router_item['options'] = array();
  741. _menu_check_access($router_item, $map);
  742. // For performance, don't localize an item the user can't access.
  743. if ($router_item['access']) {
  744. _menu_item_localize($router_item, $map);
  745. }
  746. return $map;
  747. }
  748. /**
  749. * Translates the path elements in the map using any to_arg helper function.
  750. *
  751. * @param $map
  752. * An array of path arguments; for example, array('node', '5').
  753. * @param $to_arg_functions
  754. * An array of helper functions; for example, array(2 => 'menu_tail_to_arg').
  755. *
  756. * @see hook_menu()
  757. */
  758. function _menu_link_map_translate(&$map, $to_arg_functions) {
  759. $to_arg_functions = unserialize($to_arg_functions);
  760. foreach ($to_arg_functions as $index => $function) {
  761. // Translate place-holders into real values.
  762. $arg = $function(!empty($map[$index]) ? $map[$index] : '', $map, $index);
  763. if (!empty($map[$index]) || isset($arg)) {
  764. $map[$index] = $arg;
  765. }
  766. else {
  767. unset($map[$index]);
  768. }
  769. }
  770. }
  771. /**
  772. * Returns a string containing the path relative to the current index.
  773. */
  774. function menu_tail_to_arg($arg, $map, $index) {
  775. return implode('/', array_slice($map, $index));
  776. }
  777. /**
  778. * Loads the path as one string relative to the current index.
  779. *
  780. * To use this load function, you must specify the load arguments
  781. * in the router item as:
  782. * @code
  783. * $item['load arguments'] = array('%map', '%index');
  784. * @endcode
  785. *
  786. * @see search_menu().
  787. */
  788. function menu_tail_load($arg, &$map, $index) {
  789. $arg = implode('/', array_slice($map, $index));
  790. $map = array_slice($map, 0, $index);
  791. return $arg;
  792. }
  793. /**
  794. * Provides menu link access control, translation, and argument handling.
  795. *
  796. * This function is similar to _menu_translate(), but it also does
  797. * link-specific preparation (such as always calling to_arg() functions).
  798. *
  799. * @param $item
  800. * A menu link.
  801. * @param $translate
  802. * (optional) Whether to try to translate a link containing dynamic path
  803. * argument placeholders (%) based on the menu router item of the current
  804. * path. Defaults to FALSE. Internally used for breadcrumbs.
  805. *
  806. * @return
  807. * Returns the map of path arguments with objects loaded as defined in the
  808. * $item['load_functions'].
  809. * $item['access'] becomes TRUE if the item is accessible, FALSE otherwise.
  810. * $item['href'] is generated from link_path, possibly by to_arg functions.
  811. * $item['title'] is generated from link_title, and may be localized.
  812. * $item['options'] is unserialized; it is also changed within the call here
  813. * to $item['localized_options'] by _menu_item_localize().
  814. */
  815. function _menu_link_translate(&$item, $translate = FALSE) {
  816. if (!is_array($item['options'])) {
  817. $item['options'] = unserialize($item['options']);
  818. }
  819. if ($item['external']) {
  820. $item['access'] = 1;
  821. $map = array();
  822. $item['href'] = $item['link_path'];
  823. $item['title'] = $item['link_title'];
  824. $item['localized_options'] = $item['options'];
  825. }
  826. else {
  827. // Complete the path of the menu link with elements from the current path,
  828. // if it contains dynamic placeholders (%).
  829. $map = explode('/', $item['link_path']);
  830. if (strpos($item['link_path'], '%') !== FALSE) {
  831. // Invoke registered to_arg callbacks.
  832. if (!empty($item['to_arg_functions'])) {
  833. _menu_link_map_translate($map, $item['to_arg_functions']);
  834. }
  835. // Or try to derive the path argument map from the current router item,
  836. // if this $item's path is within the router item's path. This means
  837. // that if we are on the current path 'foo/%/bar/%/baz', then
  838. // menu_get_item() will have translated the menu router item for the
  839. // current path, and we can take over the argument map for a link like
  840. // 'foo/%/bar'. This inheritance is only valid for breadcrumb links.
  841. // @see _menu_tree_check_access()
  842. // @see menu_get_active_breadcrumb()
  843. elseif ($translate && ($current_router_item = menu_get_item())) {
  844. // If $translate is TRUE, then this link is in the active trail.
  845. // Only translate paths within the current path.
  846. if (strpos($current_router_item['path'], $item['link_path']) === 0) {
  847. $count = count($map);
  848. $map = array_slice($current_router_item['original_map'], 0, $count);
  849. $item['original_map'] = $map;
  850. if (isset($current_router_item['map'])) {
  851. $item['map'] = array_slice($current_router_item['map'], 0, $count);
  852. }
  853. // Reset access to check it (for the first time).
  854. unset($item['access']);
  855. }
  856. }
  857. }
  858. $item['href'] = implode('/', $map);
  859. // Skip links containing untranslated arguments.
  860. if (strpos($item['href'], '%') !== FALSE) {
  861. $item['access'] = FALSE;
  862. return FALSE;
  863. }
  864. // menu_tree_check_access() may set this ahead of time for links to nodes.
  865. if (!isset($item['access'])) {
  866. if (!empty($item['load_functions']) && !_menu_load_objects($item, $map)) {
  867. // An error occurred loading an object.
  868. $item['access'] = FALSE;
  869. return FALSE;
  870. }
  871. _menu_check_access($item, $map);
  872. }
  873. // For performance, don't localize a link the user can't access.
  874. if ($item['access']) {
  875. _menu_item_localize($item, $map, TRUE);
  876. }
  877. }
  878. // Allow other customizations - e.g. adding a page-specific query string to the
  879. // options array. For performance reasons we only invoke this hook if the link
  880. // has the 'alter' flag set in the options array.
  881. if (!empty($item['options']['alter'])) {
  882. drupal_alter('translated_menu_link', $item, $map);
  883. }
  884. return $map;
  885. }
  886. /**
  887. * Gets a loaded object from a router item.
  888. *
  889. * menu_get_object() provides access to objects loaded by the current router
  890. * item. For example, on the page node/%node, the router loads the %node object,
  891. * and calling menu_get_object() will return that. Normally, it is necessary to
  892. * specify the type of object referenced, however node is the default.
  893. * The following example tests to see whether the node being displayed is of the
  894. * "story" content type:
  895. * @code
  896. * $node = menu_get_object();
  897. * $story = $node->type == 'story';
  898. * @endcode
  899. *
  900. * @param $type
  901. * Type of the object. These appear in hook_menu definitions as %type. Core
  902. * provides aggregator_feed, aggregator_category, contact, filter_format,
  903. * forum_term, menu, menu_link, node, taxonomy_vocabulary, user. See the
  904. * relevant {$type}_load function for more on each. Defaults to node.
  905. * @param $position
  906. * The position of the object in the path, where the first path segment is 0.
  907. * For node/%node, the position of %node is 1, but for comment/reply/%node,
  908. * it's 2. Defaults to 1.
  909. * @param $path
  910. * See menu_get_item() for more on this. Defaults to the current path.
  911. */
  912. function menu_get_object($type = 'node', $position = 1, $path = NULL) {
  913. $router_item = menu_get_item($path);
  914. if (isset($router_item['load_functions'][$position]) && !empty($router_item['map'][$position]) && $router_item['load_functions'][$position] == $type . '_load') {
  915. return $router_item['map'][$position];
  916. }
  917. }
  918. /**
  919. * Renders a menu tree based on the current path.
  920. *
  921. * The tree is expanded based on the current path and dynamic paths are also
  922. * changed according to the defined to_arg functions (for example the 'My
  923. * account' link is changed from user/% to a link with the current user's uid).
  924. *
  925. * @param $menu_name
  926. * The name of the menu.
  927. *
  928. * @return
  929. * A structured array representing the specified menu on the current page, to
  930. * be rendered by drupal_render().
  931. */
  932. function menu_tree($menu_name) {
  933. $menu_output = &drupal_static(__FUNCTION__, array());
  934. if (!isset($menu_output[$menu_name])) {
  935. $tree = menu_tree_page_data($menu_name);
  936. $menu_output[$menu_name] = menu_tree_output($tree);
  937. }
  938. return $menu_output[$menu_name];
  939. }
  940. /**
  941. * Returns an output structure for rendering a menu tree.
  942. *
  943. * The menu item's LI element is given one of the following classes:
  944. * - expanded: The menu item is showing its submenu.
  945. * - collapsed: The menu item has a submenu which is not shown.
  946. * - leaf: The menu item has no submenu.
  947. *
  948. * @param $tree
  949. * A data structure representing the tree as returned from menu_tree_data.
  950. *
  951. * @return
  952. * A structured array to be rendered by drupal_render().
  953. */
  954. function menu_tree_output($tree) {
  955. $build = array();
  956. $items = array();
  957. // Pull out just the menu links we are going to render so that we
  958. // get an accurate count for the first/last classes.
  959. foreach ($tree as $data) {
  960. if ($data['link']['access'] && !$data['link']['hidden']) {
  961. $items[] = $data;
  962. }
  963. }
  964. $router_item = menu_get_item();
  965. $num_items = count($items);
  966. foreach ($items as $i => $data) {
  967. $class = array();
  968. if ($i == 0) {
  969. $class[] = 'first';
  970. }
  971. if ($i == $num_items - 1) {
  972. $class[] = 'last';
  973. }
  974. // Set a class for the <li>-tag. Since $data['below'] may contain local
  975. // tasks, only set 'expanded' class if the link also has children within
  976. // the current menu.
  977. if ($data['link']['has_children'] && $data['below']) {
  978. $class[] = 'expanded';
  979. }
  980. elseif ($data['link']['has_children']) {
  981. $class[] = 'collapsed';
  982. }
  983. else {
  984. $class[] = 'leaf';
  985. }
  986. // Set a class if the link is in the active trail.
  987. if ($data['link']['in_active_trail']) {
  988. $class[] = 'active-trail';
  989. $data['link']['localized_options']['attributes']['class'][] = 'active-trail';
  990. }
  991. // Normally, l() compares the href of every link with $_GET['q'] and sets
  992. // the active class accordingly. But local tasks do not appear in menu
  993. // trees, so if the current path is a local task, and this link is its
  994. // tab root, then we have to set the class manually.
  995. if ($data['link']['href'] == $router_item['tab_root_href'] && $data['link']['href'] != $_GET['q']) {
  996. $data['link']['localized_options']['attributes']['class'][] = 'active';
  997. }
  998. // Allow menu-specific theme overrides.
  999. $element['#theme'] = 'menu_link__' . strtr($data['link']['menu_name'], '-', '_');
  1000. $element['#attributes']['class'] = $class;
  1001. $element['#title'] = $data['link']['title'];
  1002. $element['#href'] = $data['link']['href'];
  1003. $element['#localized_options'] = !empty($data['link']['localized_options']) ? $data['link']['localized_options'] : array();
  1004. $element['#below'] = $data['below'] ? menu_tree_output($data['below']) : $data['below'];
  1005. $element['#original_link'] = $data['link'];
  1006. // Index using the link's unique mlid.
  1007. $build[$data['link']['mlid']] = $element;
  1008. }
  1009. if ($build) {
  1010. // Make sure drupal_render() does not re-order the links.
  1011. $build['#sorted'] = TRUE;
  1012. // Add the theme wrapper for outer markup.
  1013. // Allow menu-specific theme overrides.
  1014. $build['#theme_wrappers'][] = 'menu_tree__' . strtr($data['link']['menu_name'], '-', '_');
  1015. }
  1016. return $build;
  1017. }
  1018. /**
  1019. * Gets the data structure representing a named menu tree.
  1020. *
  1021. * Since this can be the full tree including hidden items, the data returned
  1022. * may be used for generating an an admin interface or a select.
  1023. *
  1024. * @param $menu_name
  1025. * The named menu links to return
  1026. * @param $link
  1027. * A fully loaded menu link, or NULL. If a link is supplied, only the
  1028. * path to root will be included in the returned tree - as if this link
  1029. * represented the current page in a visible menu.
  1030. * @param $max_depth
  1031. * Optional maximum depth of links to retrieve. Typically useful if only one
  1032. * or two levels of a sub tree are needed in conjunction with a non-NULL
  1033. * $link, in which case $max_depth should be greater than $link['depth'].
  1034. *
  1035. * @return
  1036. * An tree of menu links in an array, in the order they should be rendered.
  1037. */
  1038. function menu_tree_all_data($menu_name, $link = NULL, $max_depth = NULL) {
  1039. $tree = &drupal_static(__FUNCTION__, array());
  1040. // Use $mlid as a flag for whether the data being loaded is for the whole tree.
  1041. $mlid = isset($link['mlid']) ? $link['mlid'] : 0;
  1042. // Generate a cache ID (cid) specific for this $menu_name, $link, $language, and depth.
  1043. $cid = 'links:' . $menu_name . ':all:' . $mlid . ':' . $GLOBALS['language']->language . ':' . (int) $max_depth;
  1044. if (!isset($tree[$cid])) {
  1045. // If the static variable doesn't have the data, check {cache_menu}.
  1046. $cache = cache_get($cid, 'cache_menu');
  1047. if ($cache && isset($cache->data)) {
  1048. // If the cache entry exists, it contains the parameters for
  1049. // menu_build_tree().
  1050. $tree_parameters = $cache->data;
  1051. }
  1052. // If the tree data was not in the cache, build $tree_parameters.
  1053. if (!isset($tree_parameters)) {
  1054. $tree_parameters = array(
  1055. 'min_depth' => 1,
  1056. 'max_depth' => $max_depth,
  1057. );
  1058. if ($mlid) {
  1059. // The tree is for a single item, so we need to match the values in its
  1060. // p columns and 0 (the top level) with the plid values of other links.
  1061. $parents = array(0);
  1062. for ($i = 1; $i < MENU_MAX_DEPTH; $i++) {
  1063. if (!empty($link["p$i"])) {
  1064. $parents[] = $link["p$i"];
  1065. }
  1066. }
  1067. $tree_parameters['expanded'] = $parents;
  1068. $tree_parameters['active_trail'] = $parents;
  1069. $tree_parameters['active_trail'][] = $mlid;
  1070. }
  1071. // Cache the tree building parameters using the page-specific cid.
  1072. cache_set($cid, $tree_parameters, 'cache_menu');
  1073. }
  1074. // Build the tree using the parameters; the resulting tree will be cached
  1075. // by _menu_build_tree()).
  1076. $tree[$cid] = menu_build_tree($menu_name, $tree_parameters);
  1077. }
  1078. return $tree[$cid];
  1079. }
  1080. /**
  1081. * Sets the path for determining the active trail of the specified menu tree.
  1082. *
  1083. * This path will also affect the breadcrumbs under some circumstances.
  1084. * Breadcrumbs are built using the preferred link returned by
  1085. * menu_link_get_preferred(). If the preferred link is inside one of the menus
  1086. * specified in calls to menu_tree_set_path(), the preferred link will be
  1087. * overridden by the corresponding path returned by menu_tree_get_path().
  1088. *
  1089. * Setting this path does not affect the main content; for that use
  1090. * menu_set_active_item() instead.
  1091. *
  1092. * @param $menu_name
  1093. * The name of the affected menu tree.
  1094. * @param $path
  1095. * The path to use when finding the active trail.
  1096. */
  1097. function menu_tree_set_path($menu_name, $path = NULL) {
  1098. $paths = &drupal_static(__FUNCTION__);
  1099. if (isset($path)) {
  1100. $paths[$menu_name] = $path;
  1101. }
  1102. return isset($paths[$menu_name]) ? $paths[$menu_name] : NULL;
  1103. }
  1104. /**
  1105. * Gets the path for determining the active trail of the specified menu tree.
  1106. *
  1107. * @param $menu_name
  1108. * The menu name of the requested tree.
  1109. *
  1110. * @return
  1111. * A string containing the path. If no path has been specified with
  1112. * menu_tree_set_path(), NULL is returned.
  1113. */
  1114. function menu_tree_get_path($menu_name) {
  1115. return menu_tree_set_path($menu_name);
  1116. }
  1117. /**
  1118. * Gets the data structure for a named menu tree, based on the current page.
  1119. *
  1120. * The tree order is maintained by storing each parent in an individual
  1121. * field, see http://drupal.org/node/141866 for more.
  1122. *
  1123. * @param $menu_name
  1124. * The named menu links to return.
  1125. * @param $max_depth
  1126. * (optional) The maximum depth of links to retrieve.
  1127. * @param $only_active_trail
  1128. * (optional) Whether to only return the links in the active trail (TRUE)
  1129. * instead of all links on every level of the menu link tree (FALSE). Defaults
  1130. * to FALSE. Internally used for breadcrumbs only.
  1131. *
  1132. * @return
  1133. * An array of menu links, in the order they should be rendered. The array
  1134. * is a list of associative arrays -- these have two keys, link and below.
  1135. * link is a menu item, ready for theming as a link. Below represents the
  1136. * submenu below the link if there is one, and it is a subtree that has the
  1137. * same structure described for the top-level array.
  1138. */
  1139. function menu_tree_page_data($menu_name, $max_depth = NULL, $only_active_trail = FALSE) {
  1140. $tree = &drupal_static(__FUNCTION__, array());
  1141. // Check if the active trail has been overridden for this menu tree.
  1142. $active_path = menu_tree_get_path($menu_name);
  1143. // Load the menu item corresponding to the current page.
  1144. if ($item = menu_get_item($active_path)) {
  1145. if (isset($max_depth)) {
  1146. $max_depth = min($max_depth, MENU_MAX_DEPTH);
  1147. }
  1148. // Generate a cache ID (cid) specific for this page.
  1149. $cid = 'links:' . $menu_name . ':page:' . $item['href'] . ':' . $GLOBALS['language']->language . ':' . (int) $item['access'] . ':' . (int) $max_depth;
  1150. // If we are asked for the active trail only, and $menu_name has not been
  1151. // built and cached for this page yet, then this likely means that it
  1152. // won't be built anymore, as this function is invoked from
  1153. // template_process_page(). So in order to not build a giant menu tree
  1154. // that needs to be checked for access on all levels, we simply check
  1155. // whether we have the menu already in cache, or otherwise, build a minimum
  1156. // tree containing the breadcrumb/active trail only.
  1157. // @see menu_set_active_trail()
  1158. if (!isset($tree[$cid]) && $only_active_trail) {
  1159. $cid .= ':trail';
  1160. }
  1161. if (!isset($tree[$cid])) {
  1162. // If the static variable doesn't have the data, check {cache_menu}.
  1163. $cache = cache_get($cid, 'cache_menu');
  1164. if ($cache && isset($cache->data)) {
  1165. // If the cache entry exists, it contains the parameters for
  1166. // menu_build_tree().
  1167. $tree_parameters = $cache->data;
  1168. }
  1169. // If the tree data was not in the cache, build $tree_parameters.
  1170. if (!isset($tree_parameters)) {
  1171. $tree_parameters = array(
  1172. 'min_depth' => 1,
  1173. 'max_depth' => $max_depth,
  1174. );
  1175. // Parent mlids; used both as key and value to ensure uniqueness.
  1176. // We always want all the top-level links with plid == 0.
  1177. $active_trail = array(0 => 0);
  1178. // If the item for the current page is accessible, build the tree
  1179. // parameters accordingly.
  1180. if ($item['access']) {
  1181. // Find a menu link corresponding to the current path. If $active_path
  1182. // is NULL, let menu_link_get_preferred() determine the path.
  1183. if ($active_link = menu_link_get_preferred($active_path, $menu_name)) {
  1184. // The active link may only be taken into account to build the
  1185. // active trail, if it resides in the requested menu. Otherwise,
  1186. // we'd needlessly re-run _menu_build_tree() queries for every menu
  1187. // on every page.
  1188. if ($active_link['menu_name'] == $menu_name) {
  1189. // Use all the coordinates, except the last one because there
  1190. // can be no child beyond the last column.
  1191. for ($i = 1; $i < MENU_MAX_DEPTH; $i++) {
  1192. if ($active_link['p' . $i]) {
  1193. $active_trail[$active_link['p' . $i]] = $active_link['p' . $i];
  1194. }
  1195. }
  1196. // If we are asked to build links for the active trail only, skip
  1197. // the entire 'expanded' handling.
  1198. if ($only_active_trail) {
  1199. $tree_parameters['only_active_trail'] = TRUE;
  1200. }
  1201. }
  1202. }
  1203. $parents = $active_trail;
  1204. $expanded = variable_get('menu_expanded', array());
  1205. // Check whether the current menu has any links set to be expanded.
  1206. if (!$only_active_trail && in_array($menu_name, $expanded)) {
  1207. // Collect all the links set to be expanded, and then add all of
  1208. // their children to the list as well.
  1209. do {
  1210. $result = db_select('menu_links', NULL, array('fetch' => PDO::FETCH_ASSOC))
  1211. ->fields('menu_links', array('mlid'))
  1212. ->condition('menu_name', $menu_name)
  1213. ->condition('expanded', 1)
  1214. ->condition('has_children', 1)
  1215. ->condition('plid', $parents, 'IN')
  1216. ->condition('mlid', $parents, 'NOT IN')
  1217. ->execute();
  1218. $num_rows = FALSE;
  1219. foreach ($result as $item) {
  1220. $parents[$item['mlid']] = $item['mlid'];
  1221. $num_rows = TRUE;
  1222. }
  1223. } while ($num_rows);
  1224. }
  1225. $tree_parameters['expanded'] = $parents;
  1226. $tree_parameters['active_trail'] = $active_trail;
  1227. }
  1228. // If access is denied, we only show top-level links in menus.
  1229. else {
  1230. $tree_parameters['expanded'] = $active_trail;
  1231. $tree_parameters['active_trail'] = $active_trail;
  1232. }
  1233. // Cache the tree building parameters using the page-specific cid.
  1234. cache_set($cid, $tree_parameters, 'cache_menu');
  1235. }
  1236. // Build the tree using the parameters; the resulting tree will be cached
  1237. // by _menu_build_tree().
  1238. $tree[$cid] = menu_build_tree($menu_name, $tree_parameters);
  1239. }
  1240. return $tree[$cid];
  1241. }
  1242. return array();
  1243. }
  1244. /**
  1245. * Builds a menu tree, translates links, and checks access.
  1246. *
  1247. * @param $menu_name
  1248. * The name of the menu.
  1249. * @param $parameters
  1250. * (optional) An associative array of build parameters. Possible keys:
  1251. * - expanded: An array of parent link ids to return only menu links that are
  1252. * children of one of the plids in this list. If empty, the whole menu tree
  1253. * is built, unless 'only_active_trail' is TRUE.
  1254. * - active_trail: An array of mlids, representing the coordinates of the
  1255. * currently active menu link.
  1256. * - only_active_trail: Whether to only return links that are in the active
  1257. * trail. This option is ignored, if 'expanded' is non-empty. Internally
  1258. * used for breadcrumbs.
  1259. * - min_depth: The minimum depth of menu links in the resulting tree.
  1260. * Defaults to 1, which is the default to build a whole tree for a menu
  1261. * (excluding menu container itself).
  1262. * - max_depth: The maximum depth of menu links in the resulting tree.
  1263. * - conditions: An associative array of custom database select query
  1264. * condition key/value pairs; see _menu_build_tree() for the actual query.
  1265. *
  1266. * @return
  1267. * A fully built menu tree.
  1268. */
  1269. function menu_build_tree($menu_name, array $parameters = array()) {
  1270. // Build the menu tree.
  1271. $data = _menu_build_tree($menu_name, $parameters);
  1272. // Check access for the current user to each item in the tree.
  1273. menu_tree_check_access($data['tree'], $data['node_links']);
  1274. return $data['tree'];
  1275. }
  1276. /**
  1277. * Builds a menu tree.
  1278. *
  1279. * This function may be used build the data for a menu tree only, for example
  1280. * to further massage the data manually before further processing happens.
  1281. * menu_tree_check_access() needs to be invoked afterwards.
  1282. *
  1283. * @see menu_build_tree()
  1284. */
  1285. function _menu_build_tree($menu_name, array $parameters = array()) {
  1286. // Static cache of already built menu trees.
  1287. $trees = &drupal_static(__FUNCTION__, array());
  1288. // Build the cache id; sort parents to prevent duplicate storage and remove
  1289. // default parameter values.
  1290. if (isset($parameters['expanded'])) {
  1291. sort($parameters['expanded']);
  1292. }
  1293. $tree_cid = 'links:' . $menu_name . ':tree-data:' . $GLOBALS['language']->language . ':' . hash('sha256', serialize($parameters));
  1294. // If we do not have this tree in the static cache, check {cache_menu}.
  1295. if (!isset($trees[$tree_cid])) {
  1296. $cache = cache_get($tree_cid, 'cache_menu');
  1297. if ($cache && isset($cache->data)) {
  1298. $trees[$tree_cid] = $cache->data;
  1299. }
  1300. }
  1301. if (!isset($trees[$tree_cid])) {
  1302. // Select the links from the table, and recursively build the tree. We
  1303. // LEFT JOIN since there is no match in {menu_router} for an external
  1304. // link.
  1305. $query = db_select('menu_links', 'ml', array('fetch' => PDO::FETCH_ASSOC));
  1306. $query->addTag('translatable');
  1307. $query->leftJoin('menu_router', 'm', 'm.path = ml.router_path');
  1308. $query->fields('ml');
  1309. $query->fields('m', array(
  1310. 'load_functions',
  1311. 'to_arg_functions',
  1312. 'access_callback',
  1313. 'access_arguments',
  1314. 'page_callback',
  1315. 'page_arguments',
  1316. 'delivery_callback',
  1317. 'tab_parent',
  1318. 'tab_root',
  1319. 'title',
  1320. 'title_callback',
  1321. 'title_arguments',
  1322. 'theme_callback',
  1323. 'theme_arguments',
  1324. 'type',
  1325. 'description',
  1326. ));
  1327. for ($i = 1; $i <= MENU_MAX_DEPTH; $i++) {
  1328. $query->orderBy('p' . $i, 'ASC');
  1329. }
  1330. $query->condition('ml.menu_name', $menu_name);
  1331. if (!empty($parameters['expanded'])) {
  1332. $query->condition('ml.plid', $parameters['expanded'], 'IN');
  1333. }
  1334. elseif (!empty($parameters['only_active_trail'])) {
  1335. $query->condition('ml.mlid', $parameters['active_trail'], 'IN');
  1336. }
  1337. $min_depth = (isset($parameters['min_depth']) ? $parameters['min_depth'] : 1);
  1338. if ($min_depth != 1) {
  1339. $query->condition('ml.depth', $min_depth, '>=');
  1340. }
  1341. if (isset($parameters['max_depth'])) {
  1342. $query->condition('ml.depth', $parameters['max_depth'], '<=');
  1343. }
  1344. // Add custom query conditions, if any were passed.
  1345. if (isset($parameters['conditions'])) {
  1346. foreach ($parameters['conditions'] as $column => $value) {
  1347. $query->condition($column, $value);
  1348. }
  1349. }
  1350. // Build an ordered array of links using the query result object.
  1351. $links = array();
  1352. foreach ($query->execute() as $item) {
  1353. $links[] = $item;
  1354. }
  1355. $active_trail = (isset($parameters['active_trail']) ? $parameters['active_trail'] : array());
  1356. $data['tree'] = menu_tree_data($links, $active_trail, $min_depth);
  1357. $data['node_links'] = array();
  1358. menu_tree_collect_node_links($data['tree'], $data['node_links']);
  1359. // Cache the data, if it is not already in the cache.
  1360. cache_set($tree_cid, $data, 'cache_menu');
  1361. $trees[$tree_cid] = $data;
  1362. }
  1363. return $trees[$tree_cid];
  1364. }
  1365. /**
  1366. * Collects node links from a given menu tree recursively.
  1367. *
  1368. * @param $tree
  1369. * The menu tree you wish to collect node links from.
  1370. * @param $node_links
  1371. * An array in which to store the collected node links.
  1372. */
  1373. function menu_tree_collect_node_links(&$tree, &$node_links) {
  1374. foreach ($tree as $key => $v) {
  1375. if ($tree[$key]['link']['router_path'] == 'node/%') {
  1376. $nid = substr($tree[$key]['link']['link_path'], 5);
  1377. if (is_numeric($nid)) {
  1378. $node_links[$nid][$tree[$key]['link']['mlid']] = &$tree[$key]['link'];
  1379. $tree[$key]['link']['access'] = FALSE;
  1380. }
  1381. }
  1382. if ($tree[$key]['below']) {
  1383. menu_tree_collect_node_links($tree[$key]['below'], $node_links);
  1384. }
  1385. }
  1386. }
  1387. /**
  1388. * Checks access and performs dynamic operations for each link in the tree.
  1389. *
  1390. * @param $tree
  1391. * The menu tree you wish to operate on.
  1392. * @param $node_links
  1393. * A collection of node link references generated from $tree by
  1394. * menu_tree_collect_node_links().
  1395. */
  1396. function menu_tree_check_access(&$tree, $node_links = array()) {
  1397. if ($node_links && (user_access('access content') || user_access('bypass node access'))) {
  1398. $nids = array_keys($node_links);
  1399. $select = db_select('node', 'n');
  1400. $select->addField('n', 'nid');
  1401. $select->condition('n.status', 1);
  1402. $select->condition('n.nid', $nids, 'IN');
  1403. $select->addTag('node_access');
  1404. $nids = $select->execute()->fetchCol();
  1405. foreach ($nids as $nid) {
  1406. foreach ($node_links[$nid] as $mlid => $link) {
  1407. $node_links[$nid][$mlid]['access'] = TRUE;
  1408. }
  1409. }
  1410. }
  1411. _menu_tree_check_access($tree);
  1412. }
  1413. /**
  1414. * Sorts the menu tree and recursively checks access for each item.
  1415. */
  1416. function _menu_tree_check_access(&$tree) {
  1417. $new_tree = array();
  1418. foreach ($tree as $key => $v) {
  1419. $item = &$tree[$key]['link'];
  1420. _menu_link_translate($item);
  1421. if ($item['access'] || ($item['in_active_trail'] && strpos($item['href'], '%') !== FALSE)) {
  1422. if ($tree[$key]['below']) {
  1423. _menu_tree_check_access($tree[$key]['below']);
  1424. }
  1425. // The weights are made a uniform 5 digits by adding 50000 as an offset.
  1426. // After _menu_link_translate(), $item['title'] has the localized link title.
  1427. // Adding the mlid to the end of the index insures that it is unique.
  1428. $new_tree[(50000 + $item['weight']) . ' ' . $item['title'] . ' ' . $item['mlid']] = $tree[$key];
  1429. }
  1430. }
  1431. // Sort siblings in the tree based on the weights and localized titles.
  1432. ksort($new_tree);
  1433. $tree = $new_tree;
  1434. }
  1435. /**
  1436. * Sorts and returns the built data representing a menu tree.
  1437. *
  1438. * @param $links
  1439. * A flat array of menu links that are part of the menu. Each array element
  1440. * is an associative array of information about the menu link, containing the
  1441. * fields from the {menu_links} table, and optionally additional information
  1442. * from the {menu_router} table, if the menu item appears in both tables.
  1443. * This array must be ordered depth-first. See _menu_build_tree() for a sample
  1444. * query.
  1445. * @param $parents
  1446. * An array of the menu link ID values that are in the path from the current
  1447. * page to the root of the menu tree.
  1448. * @param $depth
  1449. * The minimum depth to include in the returned menu tree.
  1450. *
  1451. * @return
  1452. * An array of menu links in the form of a tree. Each item in the tree is an
  1453. * associative array containing:
  1454. * - link: The menu link item from $links, with additional element
  1455. * 'in_active_trail' (TRUE if the link ID was in $parents).
  1456. * - below: An array containing the sub-tree of this item, where each element
  1457. * is a tree item array with 'link' and 'below' elements. This array will be
  1458. * empty if the menu item has no items in its sub-tree having a depth
  1459. * greater than or equal to $depth.
  1460. */
  1461. function menu_tree_data(array $links, array $parents = array(), $depth = 1) {
  1462. // Reverse the array so we can use the more efficient array_pop() function.
  1463. $links = array_reverse($links);
  1464. return _menu_tree_data($links, $parents, $depth);
  1465. }
  1466. /**
  1467. * Builds the data representing a menu tree.
  1468. *
  1469. * The function is a bit complex because the rendering of a link depends on
  1470. * the next menu link.
  1471. */
  1472. function _menu_tree_data(&$links, $parents, $depth) {
  1473. $tree = array();
  1474. while ($item = array_pop($links)) {
  1475. // We need to determine if we're on the path to root so we can later build
  1476. // the correct active trail and breadcrumb.
  1477. $item['in_active_trail'] = in_array($item['mlid'], $parents);
  1478. // Add the current link to the tree.
  1479. $tree[$item['mlid']] = array(
  1480. 'link' => $item,
  1481. 'below' => array(),
  1482. );
  1483. // Look ahead to the next link, but leave it on the array so it's available
  1484. // to other recursive function calls if we return or build a sub-tree.
  1485. $next = end($links);
  1486. // Check whether the next link is the first in a new sub-tree.
  1487. if ($next && $next['depth'] > $depth) {
  1488. // Recursively call _menu_tree_data to build the sub-tree.
  1489. $tree[$item['mlid']]['below'] = _menu_tree_data($links, $parents, $next['depth']);
  1490. // Fetch next link after filling the sub-tree.
  1491. $next = end($links);
  1492. }
  1493. // Determine if we should exit the loop and return.
  1494. if (!$next || $next['depth'] < $depth) {
  1495. break;
  1496. }
  1497. }
  1498. return $tree;
  1499. }
  1500. /**
  1501. * Implements template_preprocess_HOOK() for theme_menu_tree().
  1502. */
  1503. function template_preprocess_menu_tree(&$variables) {
  1504. $variables['tree'] = $variables['tree']['#children'];
  1505. }
  1506. /**
  1507. * Returns HTML for a wrapper for a menu sub-tree.
  1508. *
  1509. * @param $variables
  1510. * An associative array containing:
  1511. * - tree: An HTML string containing the tree's items.
  1512. *
  1513. * @see template_preprocess_menu_tree()
  1514. * @ingroup themeable
  1515. */
  1516. function theme_menu_tree($variables) {
  1517. return '<ul class="menu">' . $variables['tree'] . '</ul>';
  1518. }
  1519. /**
  1520. * Returns HTML for a menu link and submenu.
  1521. *
  1522. * @param $variables
  1523. * An associative array containing:
  1524. * - element: Structured array data for a menu link.
  1525. *
  1526. * @ingroup themeable
  1527. */
  1528. function theme_menu_link(array $variables) {
  1529. $element = $variables['element'];
  1530. $sub_menu = '';
  1531. if ($element['#below']) {
  1532. $sub_menu = drupal_render($element['#below']);
  1533. }
  1534. $output = l($element['#title'], $element['#href'], $element['#localized_options']);
  1535. return '<li' . drupal_attributes($element['#attributes']) . '>' . $output . $sub_menu . "</li>\n";
  1536. }
  1537. /**
  1538. * Returns HTML for a single local task link.
  1539. *
  1540. * @param $variables
  1541. * An associative array containing:
  1542. * - element: A render element containing:
  1543. * - #link: A menu link array with 'title', 'href', and 'localized_options'
  1544. * keys.
  1545. * - #active: A boolean indicating whether the local task is active.
  1546. *
  1547. * @ingroup themeable
  1548. */
  1549. function theme_menu_local_task($variables) {
  1550. $link = $variables['element']['#link'];
  1551. $link_text = $link['title'];
  1552. if (!empty($variables['element']['#active'])) {
  1553. // Add text to indicate active tab for non-visual users.
  1554. $active = '<span class="element-invisible">' . t('(active tab)') . '</span>';
  1555. // If the link does not contain HTML already, check_plain() it now.
  1556. // After we set 'html'=TRUE the link will not be sanitized by l().
  1557. if (empty($link['localized_options']['html'])) {
  1558. $link['title'] = check_plain($link['title']);
  1559. }
  1560. $link['localized_options']['html'] = TRUE;
  1561. $link_text = t('!local-task-title!active', array('!local-task-title' => $link['title'], '!active' => $active));
  1562. }
  1563. return '<li' . (!empty($variables['element']['#active']) ? ' class="active"' : '') . '>' . l($link_text, $link['href'], $link['localized_options']) . "</li>\n";
  1564. }
  1565. /**
  1566. * Returns HTML for a single local action link.
  1567. *
  1568. * @param $variables
  1569. * An associative array containing:
  1570. * - element: A render element containing:
  1571. * - #link: A menu link array with 'title', 'href', and 'localized_options'
  1572. * keys.
  1573. *
  1574. * @ingroup themeable
  1575. */
  1576. function theme_menu_local_action($variables) {
  1577. $link = $variables['element']['#link'];
  1578. $output = '<li>';
  1579. if (isset($link['href'])) {
  1580. $output .= l($link['title'], $link['href'], isset($link['localized_options']) ? $link['localized_options'] : array());
  1581. }
  1582. elseif (!empty($link['localized_options']['html'])) {
  1583. $output .= $link['title'];
  1584. }
  1585. else {
  1586. $output .= check_plain($link['title']);
  1587. }
  1588. $output .= "</li>\n";
  1589. return $output;
  1590. }
  1591. /**
  1592. * Generates elements for the $arg array in the help hook.
  1593. */
  1594. function drupal_help_arg($arg = array()) {
  1595. // Note - the number of empty elements should be > MENU_MAX_PARTS.
  1596. return $arg + array('', '', '', '', '', '', '', '', '', '', '', '');
  1597. }
  1598. /**
  1599. * Returns the help associated with the active menu item.
  1600. */
  1601. function menu_get_active_help() {
  1602. $output = '';
  1603. $router_path = menu_tab_root_path();
  1604. // We will always have a path unless we are on a 403 or 404.
  1605. if (!$router_path) {
  1606. return '';
  1607. }
  1608. $arg = drupal_help_arg(arg(NULL));
  1609. foreach (module_implements('help') as $module) {
  1610. $function = $module . '_help';
  1611. // Lookup help for this path.
  1612. if ($help = $function($router_path, $arg)) {
  1613. $output .= $help . "\n";
  1614. }
  1615. }
  1616. return $output;
  1617. }
  1618. /**
  1619. * Gets the custom theme for the current page, if there is one.
  1620. *
  1621. * @param $initialize
  1622. * This parameter should only be used internally; it is set to TRUE in order
  1623. * to force the custom theme to be initialized for the current page request.
  1624. *
  1625. * @return
  1626. * The machine-readable name of the custom theme, if there is one.
  1627. *
  1628. * @see menu_set_custom_theme()
  1629. */
  1630. function menu_get_custom_theme($initialize = FALSE) {
  1631. $custom_theme = &drupal_static(__FUNCTION__);
  1632. // Skip this if the site is offline or being installed or updated, since the
  1633. // menu system may not be correctly initialized then.
  1634. if ($initialize && !_menu_site_is_offline(TRUE) && (!defined('MAINTENANCE_MODE') || (MAINTENANCE_MODE != 'update' && MAINTENANCE_MODE != 'install'))) {
  1635. // First allow modules to dynamically set a custom theme for the current
  1636. // page. Since we can only have one, the last module to return a valid
  1637. // theme takes precedence.
  1638. $custom_themes = array_filter(module_invoke_all('custom_theme'), 'drupal_theme_access');
  1639. if (!empty($custom_themes)) {
  1640. $custom_theme = array_pop($custom_themes);
  1641. }
  1642. // If there is a theme callback function for the current page, execute it.
  1643. // If this returns a valid theme, it will override any theme that was set
  1644. // by a hook_custom_theme() implementation above.
  1645. $router_item = menu_get_item();
  1646. if (!empty($router_item['access']) && !empty($router_item['theme_callback']) && function_exists($router_item['theme_callback'])) {
  1647. $theme_name = call_user_func_array($router_item['theme_callback'], $router_item['theme_arguments']);
  1648. if (drupal_theme_access($theme_name)) {
  1649. $custom_theme = $theme_name;
  1650. }
  1651. }
  1652. }
  1653. return $custom_theme;
  1654. }
  1655. /**
  1656. * Sets a custom theme for the current page, if there is one.
  1657. */
  1658. function menu_set_custom_theme() {
  1659. menu_get_custom_theme(TRUE);
  1660. }
  1661. /**
  1662. * Build a list of named menus.
  1663. */
  1664. function menu_get_names() {
  1665. $names = &drupal_static(__FUNCTION__);
  1666. if (empty($names)) {
  1667. $names = db_select('menu_links')
  1668. ->distinct()
  1669. ->fields('menu_links', array('menu_name'))
  1670. ->orderBy('menu_name')
  1671. ->execute()->fetchCol();
  1672. }
  1673. return $names;
  1674. }
  1675. /**
  1676. * Returns an array containing the names of system-defined (default) menus.
  1677. */
  1678. function menu_list_system_menus() {
  1679. return array(
  1680. 'navigation' => 'Navigation',
  1681. 'management' => 'Management',
  1682. 'user-menu' => 'User menu',
  1683. 'main-menu' => 'Main menu',
  1684. );
  1685. }
  1686. /**
  1687. * Returns an array of links to be rendered as the Main menu.
  1688. */
  1689. function menu_main_menu() {
  1690. return menu_navigation_links(variable_get('menu_main_links_source', 'main-menu'));
  1691. }
  1692. /**
  1693. * Returns an array of links to be rendered as the Secondary links.
  1694. */
  1695. function menu_secondary_menu() {
  1696. // If the secondary menu source is set as the primary menu, we display the
  1697. // second level of the primary menu.
  1698. if (variable_get('menu_secondary_links_source', 'user-menu') == variable_get('menu_main_links_source', 'main-menu')) {
  1699. return menu_navigation_links(variable_get('menu_main_links_source', 'main-menu'), 1);
  1700. }
  1701. else {
  1702. return menu_navigation_links(variable_get('menu_secondary_links_source', 'user-menu'), 0);
  1703. }
  1704. }
  1705. /**
  1706. * Returns an array of links for a navigation menu.
  1707. *
  1708. * @param $menu_name
  1709. * The name of the menu.
  1710. * @param $level
  1711. * Optional, the depth of the menu to be returned.
  1712. *
  1713. * @return
  1714. * An array of links of the specified menu and level.
  1715. */
  1716. function menu_navigation_links($menu_name, $level = 0) {
  1717. // Don't even bother querying the menu table if no menu is specified.
  1718. if (empty($menu_name)) {
  1719. return array();
  1720. }
  1721. // Get the menu hierarchy for the current page.
  1722. $tree = menu_tree_page_data($menu_name, $level + 1);
  1723. // Go down the active trail until the right level is reached.
  1724. while ($level-- > 0 && $tree) {
  1725. // Loop through the current level's items until we find one that is in trail.
  1726. while ($item = array_shift($tree)) {
  1727. if ($item['link']['in_active_trail']) {
  1728. // If the item is in the active trail, we continue in the subtree.
  1729. $tree = empty($item['below']) ? array() : $item['below'];
  1730. break;
  1731. }
  1732. }
  1733. }
  1734. // Create a single level of links.
  1735. $router_item = menu_get_item();
  1736. $links = array();
  1737. foreach ($tree as $item) {
  1738. if (!$item['link']['hidden']) {
  1739. $class = '';
  1740. $l = $item['link']['localized_options'];
  1741. $l['href'] = $item['link']['href'];
  1742. $l['title'] = $item['link']['title'];
  1743. if ($item['link']['in_active_trail']) {
  1744. $class = ' active-trail';
  1745. $l['attributes']['class'][] = 'active-trail';
  1746. }
  1747. // Normally, l() compares the href of every link with $_GET['q'] and sets
  1748. // the active class accordingly. But local tasks do not appear in menu
  1749. // trees, so if the current path is a local task, and this link is its
  1750. // tab root, then we have to set the class manually.
  1751. if ($item['link']['href'] == $router_item['tab_root_href'] && $item['link']['href'] != $_GET['q']) {
  1752. $l['attributes']['class'][] = 'active';
  1753. }
  1754. // Keyed with the unique mlid to generate classes in theme_links().
  1755. $links['menu-' . $item['link']['mlid'] . $class] = $l;
  1756. }
  1757. }
  1758. return $links;
  1759. }
  1760. /**
  1761. * Collects the local tasks (tabs), action links, and the root path.
  1762. *
  1763. * @param $level
  1764. * The level of tasks you ask for. Primary tasks are 0, secondary are 1.
  1765. *
  1766. * @return
  1767. * An array containing
  1768. * - tabs: Local tasks for the requested level:
  1769. * - count: The number of local tasks.
  1770. * - output: The themed output of local tasks.
  1771. * - actions: Action links for the requested level:
  1772. * - count: The number of action links.
  1773. * - output: The themed output of action links.
  1774. * - root_path: The router path for the current page. If the current page is
  1775. * a default local task, then this corresponds to the parent tab.
  1776. */
  1777. function menu_local_tasks($level = 0) {
  1778. $data = &drupal_static(__FUNCTION__);
  1779. $root_path = &drupal_static(__FUNCTION__ . ':root_path', '');
  1780. $empty = array(
  1781. 'tabs' => array('count' => 0, 'output' => array()),
  1782. 'actions' => array('count' => 0, 'output' => array()),
  1783. 'root_path' => &$root_path,
  1784. );
  1785. if (!isset($data)) {
  1786. $data = array();
  1787. // Set defaults in case there are no actions or tabs.
  1788. $actions = $empty['actions'];
  1789. $tabs = array();
  1790. $router_item = menu_get_item();
  1791. // If this router item points to its parent, start from the parents to
  1792. // compute tabs and actions.
  1793. if ($router_item && ($router_item['type'] & MENU_LINKS_TO_PARENT)) {
  1794. $router_item = menu_get_item($router_item['tab_parent_href']);
  1795. }
  1796. // If we failed to fetch a router item or the current user doesn't have
  1797. // access to it, don't bother computing the tabs.
  1798. if (!$router_item || !$router_item['access']) {
  1799. return $empty;
  1800. }
  1801. // Get all tabs (also known as local tasks) and the root page.
  1802. $cid = 'local_tasks:' . $router_item['tab_root'];
  1803. if ($cache = cache_get($cid, 'cache_menu')) {
  1804. $result = $cache->data;
  1805. }
  1806. else {
  1807. $result = db_select('menu_router', NULL, array('fetch' => PDO::FETCH_ASSOC))
  1808. ->fields('menu_router')
  1809. ->condition('tab_root', $router_item['tab_root'])
  1810. ->condition('context', MENU_CONTEXT_INLINE, '<>')
  1811. ->orderBy('weight')
  1812. ->orderBy('title')
  1813. ->execute()
  1814. ->fetchAll();
  1815. cache_set($cid, $result, 'cache_menu');
  1816. }
  1817. $map = $router_item['original_map'];
  1818. $children = array();
  1819. $tasks = array();
  1820. $root_path = $router_item['path'];
  1821. foreach ($result as $item) {
  1822. _menu_translate($item, $map, TRUE);
  1823. if ($item['tab_parent']) {
  1824. // All tabs, but not the root page.
  1825. $children[$item['tab_parent']][$item['path']] = $item;
  1826. }
  1827. // Store the translated item for later use.
  1828. $tasks[$item['path']] = $item;
  1829. }
  1830. // Find all tabs below the current path.
  1831. $path = $router_item['path'];
  1832. // Tab parenting may skip levels, so the number of parts in the path may not
  1833. // equal the depth. Thus we use the $depth counter (offset by 1000 for ksort).
  1834. $depth = 1001;
  1835. $actions['count'] = 0;
  1836. $actions['output'] = array();
  1837. while (isset($children[$path])) {
  1838. $tabs_current = array();
  1839. $actions_current = array();
  1840. $next_path = '';
  1841. $tab_count = 0;
  1842. $action_count = 0;
  1843. foreach ($children[$path] as $item) {
  1844. // Local tasks can be normal items too, so bitmask with
  1845. // MENU_IS_LOCAL_TASK before checking.
  1846. if (!($item['type'] & MENU_IS_LOCAL_TASK)) {
  1847. // This item is not a tab, skip it.
  1848. continue;
  1849. }
  1850. if ($item['access']) {
  1851. $link = $item;
  1852. // The default task is always active. As tabs can be normal items
  1853. // too, so bitmask with MENU_LINKS_TO_PARENT before checking.
  1854. if (($item['type'] & MENU_LINKS_TO_PARENT) == MENU_LINKS_TO_PARENT) {
  1855. // Find the first parent which is not a default local task or action.
  1856. for ($p = $item['tab_parent']; ($tasks[$p]['type'] & MENU_LINKS_TO_PARENT) == MENU_LINKS_TO_PARENT; $p = $tasks[$p]['tab_parent']);
  1857. // Use the path of the parent instead.
  1858. $link['href'] = $tasks[$p]['href'];
  1859. // Mark the link as active, if the current path happens to be the
  1860. // path of the default local task itself (i.e., instead of its
  1861. // tab_parent_href or tab_root_href). Normally, links for default
  1862. // local tasks link to their parent, but the path of default local
  1863. // tasks can still be accessed directly, in which case this link
  1864. // would not be marked as active, since l() only compares the href
  1865. // with $_GET['q'].
  1866. if ($link['href'] != $_GET['q']) {
  1867. $link['localized_options']['attributes']['class'][] = 'active';
  1868. }
  1869. $tabs_current[] = array(
  1870. '#theme' => 'menu_local_task',
  1871. '#link' => $link,
  1872. '#active' => TRUE,
  1873. );
  1874. $next_path = $item['path'];
  1875. $tab_count++;
  1876. }
  1877. else {
  1878. // Actions can be normal items too, so bitmask with
  1879. // MENU_IS_LOCAL_ACTION before checking.
  1880. if (($item['type'] & MENU_IS_LOCAL_ACTION) == MENU_IS_LOCAL_ACTION) {
  1881. // The item is an action, display it as such.
  1882. $actions_current[] = array(
  1883. '#theme' => 'menu_local_action',
  1884. '#link' => $link,
  1885. );
  1886. $action_count++;
  1887. }
  1888. else {
  1889. // Otherwise, it's a normal tab.
  1890. $tabs_current[] = array(
  1891. '#theme' => 'menu_local_task',
  1892. '#link' => $link,
  1893. );
  1894. $tab_count++;
  1895. }
  1896. }
  1897. }
  1898. }
  1899. $path = $next_path;
  1900. $tabs[$depth]['count'] = $tab_count;
  1901. $tabs[$depth]['output'] = $tabs_current;
  1902. $actions['count'] += $action_count;
  1903. $actions['output'] = array_merge($actions['output'], $actions_current);
  1904. $depth++;
  1905. }
  1906. $data['actions'] = $actions;
  1907. // Find all tabs at the same level or above the current one.
  1908. $parent = $router_item['tab_parent'];
  1909. $path = $router_item['path'];
  1910. $current = $router_item;
  1911. $depth = 1000;
  1912. while (isset($children[$parent])) {
  1913. $tabs_current = array();
  1914. $next_path = '';
  1915. $next_parent = '';
  1916. $count = 0;
  1917. foreach ($children[$parent] as $item) {
  1918. // Skip local actions.
  1919. if ($item['type'] & MENU_IS_LOCAL_ACTION) {
  1920. continue;
  1921. }
  1922. if ($item['access']) {
  1923. $count++;
  1924. $link = $item;
  1925. // Local tasks can be normal items too, so bitmask with
  1926. // MENU_LINKS_TO_PARENT before checking.
  1927. if (($item['type'] & MENU_LINKS_TO_PARENT) == MENU_LINKS_TO_PARENT) {
  1928. // Find the first parent which is not a default local task.
  1929. for ($p = $item['tab_parent']; ($tasks[$p]['type'] & MENU_LINKS_TO_PARENT) == MENU_LINKS_TO_PARENT; $p = $tasks[$p]['tab_parent']);
  1930. // Use the path of the parent instead.
  1931. $link['href'] = $tasks[$p]['href'];
  1932. if ($item['path'] == $router_item['path']) {
  1933. $root_path = $tasks[$p]['path'];
  1934. }
  1935. }
  1936. // We check for the active tab.
  1937. if ($item['path'] == $path) {
  1938. // Mark the link as active, if the current path is a (second-level)
  1939. // local task of a default local task. Since this default local task
  1940. // links to its parent, l() will not mark it as active, as it only
  1941. // compares the link's href to $_GET['q'].
  1942. if ($link['href'] != $_GET['q']) {
  1943. $link['localized_options']['attributes']['class'][] = 'active';
  1944. }
  1945. $tabs_current[] = array(
  1946. '#theme' => 'menu_local_task',
  1947. '#link' => $link,
  1948. '#active' => TRUE,
  1949. );
  1950. $next_path = $item['tab_parent'];
  1951. if (isset($tasks[$next_path])) {
  1952. $next_parent = $tasks[$next_path]['tab_parent'];
  1953. }
  1954. }
  1955. else {
  1956. $tabs_current[] = array(
  1957. '#theme' => 'menu_local_task',
  1958. '#link' => $link,
  1959. );
  1960. }
  1961. }
  1962. }
  1963. $path = $next_path;
  1964. $parent = $next_parent;
  1965. $tabs[$depth]['count'] = $count;
  1966. $tabs[$depth]['output'] = $tabs_current;
  1967. $depth--;
  1968. }
  1969. // Sort by depth.
  1970. ksort($tabs);
  1971. // Remove the depth, we are interested only in their relative placement.
  1972. $tabs = array_values($tabs);
  1973. $data['tabs'] = $tabs;
  1974. // Allow modules to alter local tasks or dynamically append further tasks.
  1975. drupal_alter('menu_local_tasks', $data, $router_item, $root_path);
  1976. }
  1977. if (isset($data['tabs'][$level])) {
  1978. return array(
  1979. 'tabs' => $data['tabs'][$level],
  1980. 'actions' => $data['actions'],
  1981. 'root_path' => $root_path,
  1982. );
  1983. }
  1984. // @todo If there are no tabs, then there still can be actions; for example,
  1985. // when added via hook_menu_local_tasks_alter().
  1986. elseif (!empty($data['actions']['output'])) {
  1987. return array('actions' => $data['actions']) + $empty;
  1988. }
  1989. return $empty;
  1990. }
  1991. /**
  1992. * Retrieves contextual links for a path based on registered local tasks.
  1993. *
  1994. * This leverages the menu system to retrieve the first layer of registered
  1995. * local tasks for a given system path. All local tasks of the tab type
  1996. * MENU_CONTEXT_INLINE are taken into account.
  1997. *
  1998. * For example, when considering the following registered local tasks:
  1999. * - node/%node/view (default local task) with no 'context' defined
  2000. * - node/%node/edit with context: MENU_CONTEXT_PAGE | MENU_CONTEXT_INLINE
  2001. * - node/%node/revisions with context: MENU_CONTEXT_PAGE
  2002. * - node/%node/report-as-spam with context: MENU_CONTEXT_INLINE
  2003. *
  2004. * If the path "node/123" is passed to this function, then it will return the
  2005. * links for 'edit' and 'report-as-spam'.
  2006. *
  2007. * @param $module
  2008. * The name of the implementing module. This is used to prefix the key for
  2009. * each contextual link, which is transformed into a CSS class during
  2010. * rendering by theme_links(). For example, if $module is 'block' and the
  2011. * retrieved local task path argument is 'edit', then the resulting CSS class
  2012. * will be 'block-edit'.
  2013. * @param $parent_path
  2014. * The static menu router path of the object to retrieve local tasks for, for
  2015. * example 'node' or 'admin/structure/block/manage'.
  2016. * @param $args
  2017. * A list of dynamic path arguments to append to $parent_path to form the
  2018. * fully-qualified menu router path; for example, array(123) for a certain
  2019. * node or array('system', 'navigation') for a certain block.
  2020. *
  2021. * @return
  2022. * A list of menu router items that are local tasks for the passed-in path.
  2023. *
  2024. * @see contextual_links_preprocess()
  2025. * @see hook_menu()
  2026. */
  2027. function menu_contextual_links($module, $parent_path, $args) {
  2028. static $path_empty = array();
  2029. $links = array();
  2030. // Performance: In case a previous invocation for the same parent path did not
  2031. // return any links, we immediately return here.
  2032. if (isset($path_empty[$parent_path]) && strpos($parent_path, '%') !== FALSE) {
  2033. return $links;
  2034. }
  2035. // Construct the item-specific parent path.
  2036. $path = $parent_path . '/' . implode('/', $args);
  2037. // Get the router item for the given parent link path.
  2038. $router_item = menu_get_item($path);
  2039. if (!$router_item || !$router_item['access']) {
  2040. $path_empty[$parent_path] = TRUE;
  2041. return $links;
  2042. }
  2043. $data = &drupal_static(__FUNCTION__, array());
  2044. $root_path = $router_item['path'];
  2045. // Performance: For a single, normalized path (such as 'node/%') we only query
  2046. // available tasks once per request.
  2047. if (!isset($data[$root_path])) {
  2048. // Get all contextual links that are direct children of the router item and
  2049. // not of the tab type 'view'.
  2050. $data[$root_path] = db_select('menu_router', 'm')
  2051. ->fields('m')
  2052. ->condition('tab_parent', $router_item['tab_root'])
  2053. ->condition('context', MENU_CONTEXT_NONE, '<>')
  2054. ->condition('context', MENU_CONTEXT_PAGE, '<>')
  2055. ->orderBy('weight')
  2056. ->orderBy('title')
  2057. ->execute()
  2058. ->fetchAllAssoc('path', PDO::FETCH_ASSOC);
  2059. }
  2060. $parent_length = drupal_strlen($root_path) + 1;
  2061. $map = $router_item['original_map'];
  2062. foreach ($data[$root_path] as $item) {
  2063. // Extract the actual "task" string from the path argument.
  2064. $key = drupal_substr($item['path'], $parent_length);
  2065. // Denormalize and translate the contextual link.
  2066. _menu_translate($item, $map, TRUE);
  2067. if (!$item['access']) {
  2068. continue;
  2069. }
  2070. // All contextual links are keyed by the actual "task" path argument,
  2071. // prefixed with the name of the implementing module.
  2072. $links[$module . '-' . $key] = $item;
  2073. }
  2074. // Allow modules to alter contextual links.
  2075. drupal_alter('menu_contextual_links', $links, $router_item, $root_path);
  2076. // Performance: If the current user does not have access to any links for this
  2077. // router path and no other module added further links, we assign FALSE here
  2078. // to skip the entire process the next time the same router path is requested.
  2079. if (empty($links)) {
  2080. $path_empty[$parent_path] = TRUE;
  2081. }
  2082. return $links;
  2083. }
  2084. /**
  2085. * Returns the rendered local tasks at the top level.
  2086. */
  2087. function menu_primary_local_tasks() {
  2088. $links = menu_local_tasks(0);
  2089. // Do not display single tabs.
  2090. return ($links['tabs']['count'] > 1 ? $links['tabs']['output'] : '');
  2091. }
  2092. /**
  2093. * Returns the rendered local tasks at the second level.
  2094. */
  2095. function menu_secondary_local_tasks() {
  2096. $links = menu_local_tasks(1);
  2097. // Do not display single tabs.
  2098. return ($links['tabs']['count'] > 1 ? $links['tabs']['output'] : '');
  2099. }
  2100. /**
  2101. * Returns the rendered local actions at the current level.
  2102. */
  2103. function menu_local_actions() {
  2104. $links = menu_local_tasks();
  2105. return $links['actions']['output'];
  2106. }
  2107. /**
  2108. * Returns the router path, or the path for a default local task's parent.
  2109. */
  2110. function menu_tab_root_path() {
  2111. $links = menu_local_tasks();
  2112. return $links['root_path'];
  2113. }
  2114. /**
  2115. * Returns a renderable element for the primary and secondary tabs.
  2116. */
  2117. function menu_local_tabs() {
  2118. return array(
  2119. '#theme' => 'menu_local_tasks',
  2120. '#primary' => menu_primary_local_tasks(),
  2121. '#secondary' => menu_secondary_local_tasks(),
  2122. );
  2123. }
  2124. /**
  2125. * Returns HTML for primary and secondary local tasks.
  2126. *
  2127. * @param $variables
  2128. * An associative array containing:
  2129. * - primary: (optional) An array of local tasks (tabs).
  2130. * - secondary: (optional) An array of local tasks (tabs).
  2131. *
  2132. * @ingroup themeable
  2133. * @see menu_local_tasks()
  2134. */
  2135. function theme_menu_local_tasks(&$variables) {
  2136. $output = '';
  2137. if (!empty($variables['primary'])) {
  2138. $variables['primary']['#prefix'] = '<h2 class="element-invisible">' . t('Primary tabs') . '</h2>';
  2139. $variables['primary']['#prefix'] .= '<ul class="tabs primary">';
  2140. $variables['primary']['#suffix'] = '</ul>';
  2141. $output .= drupal_render($variables['primary']);
  2142. }
  2143. if (!empty($variables['secondary'])) {
  2144. $variables['secondary']['#prefix'] = '<h2 class="element-invisible">' . t('Secondary tabs') . '</h2>';
  2145. $variables['secondary']['#prefix'] .= '<ul class="tabs secondary">';
  2146. $variables['secondary']['#suffix'] = '</ul>';
  2147. $output .= drupal_render($variables['secondary']);
  2148. }
  2149. return $output;
  2150. }
  2151. /**
  2152. * Sets (or gets) the active menu for the current page.
  2153. *
  2154. * The active menu for the page determines the active trail.
  2155. *
  2156. * @return
  2157. * An array of menu machine names, in order of preference. The
  2158. * 'menu_default_active_menus' variable may be used to assert a menu order
  2159. * different from the order of creation, or to prevent a particular menu from
  2160. * being used at all in the active trail.
  2161. * E.g., $conf['menu_default_active_menus'] = array('navigation', 'main-menu')
  2162. */
  2163. function menu_set_active_menu_names($menu_names = NULL) {
  2164. $active = &drupal_static(__FUNCTION__);
  2165. if (isset($menu_names) && is_array($menu_names)) {
  2166. $active = $menu_names;
  2167. }
  2168. elseif (!isset($active)) {
  2169. $active = variable_get('menu_default_active_menus', array_keys(menu_list_system_menus()));
  2170. }
  2171. return $active;
  2172. }
  2173. /**
  2174. * Gets the active menu for the current page.
  2175. */
  2176. function menu_get_active_menu_names() {
  2177. return menu_set_active_menu_names();
  2178. }
  2179. /**
  2180. * Sets the active path, which determines which page is loaded.
  2181. *
  2182. * Note that this may not have the desired effect unless invoked very early
  2183. * in the page load, such as during hook_boot(), or unless you call
  2184. * menu_execute_active_handler() to generate your page output.
  2185. *
  2186. * @param $path
  2187. * A Drupal path - not a path alias.
  2188. */
  2189. function menu_set_active_item($path) {
  2190. $_GET['q'] = $path;
  2191. // Since the active item has changed, the active menu trail may also be out
  2192. // of date.
  2193. drupal_static_reset('menu_set_active_trail');
  2194. }
  2195. /**
  2196. * Sets the active trail (path to the menu tree root) of the current page.
  2197. *
  2198. * Any trail set by this function will only be used for functionality that calls
  2199. * menu_get_active_trail(). Drupal core only uses trails set here for
  2200. * breadcrumbs and the page title and not for menu trees or page content.
  2201. * Additionally, breadcrumbs set by drupal_set_breadcrumb() will override any
  2202. * trail set here.
  2203. *
  2204. * To affect the trail used by menu trees, use menu_tree_set_path(). To affect
  2205. * the page content, use menu_set_active_item() instead.
  2206. *
  2207. * @param $new_trail
  2208. * Menu trail to set; the value is saved in a static variable and can be
  2209. * retrieved by menu_get_active_trail(). The format of this array should be
  2210. * the same as the return value of menu_get_active_trail().
  2211. *
  2212. * @return
  2213. * The active trail. See menu_get_active_trail() for details.
  2214. */
  2215. function menu_set_active_trail($new_trail = NULL) {
  2216. $trail = &drupal_static(__FUNCTION__);
  2217. if (isset($new_trail)) {
  2218. $trail = $new_trail;
  2219. }
  2220. elseif (!isset($trail)) {
  2221. $trail = array();
  2222. $trail[] = array(
  2223. 'title' => t('Home'),
  2224. 'href' => '<front>',
  2225. 'link_path' => '',
  2226. 'localized_options' => array(),
  2227. 'type' => 0,
  2228. );
  2229. // Try to retrieve a menu link corresponding to the current path. If more
  2230. // than one exists, the link from the most preferred menu is returned.
  2231. $preferred_link = menu_link_get_preferred();
  2232. $current_item = menu_get_item();
  2233. // There is a link for the current path.
  2234. if ($preferred_link) {
  2235. // Pass TRUE for $only_active_trail to make menu_tree_page_data() build
  2236. // a stripped down menu tree containing the active trail only, in case
  2237. // the given menu has not been built in this request yet.
  2238. $tree = menu_tree_page_data($preferred_link['menu_name'], NULL, TRUE);
  2239. list($key, $curr) = each($tree);
  2240. }
  2241. // There is no link for the current path.
  2242. else {
  2243. $preferred_link = $current_item;
  2244. $curr = FALSE;
  2245. }
  2246. while ($curr) {
  2247. $link = $curr['link'];
  2248. if ($link['in_active_trail']) {
  2249. // Add the link to the trail, unless it links to its parent.
  2250. if (!($link['type'] & MENU_LINKS_TO_PARENT)) {
  2251. // The menu tree for the active trail may contain additional links
  2252. // that have not been translated yet, since they contain dynamic
  2253. // argument placeholders (%). Such links are not contained in regular
  2254. // menu trees, and have only been loaded for the additional
  2255. // translation that happens here, so as to be able to display them in
  2256. // the breadcumb for the current page.
  2257. // @see _menu_tree_check_access()
  2258. // @see _menu_link_translate()
  2259. if (strpos($link['href'], '%') !== FALSE) {
  2260. _menu_link_translate($link, TRUE);
  2261. }
  2262. if ($link['access']) {
  2263. $trail[] = $link;
  2264. }
  2265. }
  2266. $tree = $curr['below'] ? $curr['below'] : array();
  2267. }
  2268. list($key, $curr) = each($tree);
  2269. }
  2270. // Make sure the current page is in the trail to build the page title, by
  2271. // appending either the preferred link or the menu router item for the
  2272. // current page. Exclude it if we are on the front page.
  2273. $last = end($trail);
  2274. if ($preferred_link && $last['href'] != $preferred_link['href'] && !drupal_is_front_page()) {
  2275. $trail[] = $preferred_link;
  2276. }
  2277. }
  2278. return $trail;
  2279. }
  2280. /**
  2281. * Looks up the preferred menu link for a given system path.
  2282. *
  2283. * @param $path
  2284. * The path; for example, 'node/5'. The function will find the corresponding
  2285. * menu link ('node/5' if it exists, or fallback to 'node/%').
  2286. * @param $selected_menu
  2287. * The name of a menu used to restrict the search for a preferred menu link.
  2288. * If not specified, all the menus returned by menu_get_active_menu_names()
  2289. * will be used.
  2290. *
  2291. * @return
  2292. * A fully translated menu link, or FALSE if no matching menu link was
  2293. * found. The most specific menu link ('node/5' preferred over 'node/%') in
  2294. * the most preferred menu (as defined by menu_get_active_menu_names()) is
  2295. * returned.
  2296. */
  2297. function menu_link_get_preferred($path = NULL, $selected_menu = NULL) {
  2298. $preferred_links = &drupal_static(__FUNCTION__);
  2299. if (!isset($path)) {
  2300. $path = $_GET['q'];
  2301. }
  2302. if (empty($selected_menu)) {
  2303. // Use an illegal menu name as the key for the preferred menu link.
  2304. $selected_menu = MENU_PREFERRED_LINK;
  2305. }
  2306. if (!isset($preferred_links[$path])) {
  2307. // Look for the correct menu link by building a list of candidate paths,
  2308. // which are ordered by priority (translated hrefs are preferred over
  2309. // untranslated paths). Afterwards, the most relevant path is picked from
  2310. // the menus, ordered by menu preference.
  2311. $item = menu_get_item($path);
  2312. $path_candidates = array();
  2313. // 1. The current item href.
  2314. $path_candidates[$item['href']] = $item['href'];
  2315. // 2. The tab root href of the current item (if any).
  2316. if ($item['tab_parent'] && ($tab_root = menu_get_item($item['tab_root_href']))) {
  2317. $path_candidates[$tab_root['href']] = $tab_root['href'];
  2318. }
  2319. // 3. The current item path (with wildcards).
  2320. $path_candidates[$item['path']] = $item['path'];
  2321. // 4. The tab root path of the current item (if any).
  2322. if (!empty($tab_root)) {
  2323. $path_candidates[$tab_root['path']] = $tab_root['path'];
  2324. }
  2325. // Retrieve a list of menu names, ordered by preference.
  2326. $menu_names = menu_get_active_menu_names();
  2327. // Put the selected menu at the front of the list.
  2328. array_unshift($menu_names, $selected_menu);
  2329. $query = db_select('menu_links', 'ml', array('fetch' => PDO::FETCH_ASSOC));
  2330. $query->leftJoin('menu_router', 'm', 'm.path = ml.router_path');
  2331. $query->fields('ml');
  2332. // Weight must be taken from {menu_links}, not {menu_router}.
  2333. $query->addField('ml', 'weight', 'link_weight');
  2334. $query->fields('m');
  2335. $query->condition('ml.link_path', $path_candidates, 'IN');
  2336. $query->addTag('preferred_menu_links');
  2337. // Sort candidates by link path and menu name.
  2338. $candidates = array();
  2339. foreach ($query->execute() as $candidate) {
  2340. $candidate['weight'] = $candidate['link_weight'];
  2341. $candidates[$candidate['link_path']][$candidate['menu_name']] = $candidate;
  2342. // Add any menus not already in the menu name search list.
  2343. if (!in_array($candidate['menu_name'], $menu_names)) {
  2344. $menu_names[] = $candidate['menu_name'];
  2345. }
  2346. }
  2347. // Store the most specific link for each menu. Also save the most specific
  2348. // link of the most preferred menu in $preferred_link.
  2349. foreach ($path_candidates as $link_path) {
  2350. if (isset($candidates[$link_path])) {
  2351. foreach ($menu_names as $menu_name) {
  2352. if (empty($preferred_links[$path][$menu_name]) && isset($candidates[$link_path][$menu_name])) {
  2353. $candidate_item = $candidates[$link_path][$menu_name];
  2354. $map = explode('/', $path);
  2355. _menu_translate($candidate_item, $map);
  2356. if ($candidate_item['access']) {
  2357. $preferred_links[$path][$menu_name] = $candidate_item;
  2358. if (empty($preferred_links[$path][MENU_PREFERRED_LINK])) {
  2359. // Store the most specific link.
  2360. $preferred_links[$path][MENU_PREFERRED_LINK] = $candidate_item;
  2361. }
  2362. }
  2363. }
  2364. }
  2365. }
  2366. }
  2367. }
  2368. return isset($preferred_links[$path][$selected_menu]) ? $preferred_links[$path][$selected_menu] : FALSE;
  2369. }
  2370. /**
  2371. * Gets the active trail (path to root menu root) of the current page.
  2372. *
  2373. * If a trail is supplied to menu_set_active_trail(), that value is returned. If
  2374. * a trail is not supplied to menu_set_active_trail(), the path to the current
  2375. * page is calculated and returned. The calculated trail is also saved as a
  2376. * static value for use by subsequent calls to menu_get_active_trail().
  2377. *
  2378. * @return
  2379. * Path to menu root of the current page, as an array of menu link items,
  2380. * starting with the site's home page. Each link item is an associative array
  2381. * with the following components:
  2382. * - title: Title of the item.
  2383. * - href: Drupal path of the item.
  2384. * - localized_options: Options for passing into the l() function.
  2385. * - type: A menu type constant, such as MENU_DEFAULT_LOCAL_TASK, or 0 to
  2386. * indicate it's not really in the menu (used for the home page item).
  2387. */
  2388. function menu_get_active_trail() {
  2389. return menu_set_active_trail();
  2390. }
  2391. /**
  2392. * Gets the breadcrumb for the current page, as determined by the active trail.
  2393. *
  2394. * @see menu_set_active_trail()
  2395. */
  2396. function menu_get_active_breadcrumb() {
  2397. $breadcrumb = array();
  2398. // No breadcrumb for the front page.
  2399. if (drupal_is_front_page()) {
  2400. return $breadcrumb;
  2401. }
  2402. $item = menu_get_item();
  2403. if (!empty($item['access'])) {
  2404. $active_trail = menu_get_active_trail();
  2405. // Allow modules to alter the breadcrumb, if possible, as that is much
  2406. // faster than rebuilding an entirely new active trail.
  2407. drupal_alter('menu_breadcrumb', $active_trail, $item);
  2408. // Don't show a link to the current page in the breadcrumb trail.
  2409. $end = end($active_trail);
  2410. if ($item['href'] == $end['href']) {
  2411. array_pop($active_trail);
  2412. }
  2413. // Remove the tab root (parent) if the current path links to its parent.
  2414. // Normally, the tab root link is included in the breadcrumb, as soon as we
  2415. // are on a local task or any other child link. However, if we are on a
  2416. // default local task (e.g., node/%/view), then we do not want the tab root
  2417. // link (e.g., node/%) to appear, as it would be identical to the current
  2418. // page. Since this behavior also needs to work recursively (i.e., on
  2419. // default local tasks of default local tasks), and since the last non-task
  2420. // link in the trail is used as page title (see menu_get_active_title()),
  2421. // this condition cannot be cleanly integrated into menu_get_active_trail().
  2422. // menu_get_active_trail() already skips all links that link to their parent
  2423. // (commonly MENU_DEFAULT_LOCAL_TASK). In order to also hide the parent link
  2424. // itself, we always remove the last link in the trail, if the current
  2425. // router item links to its parent.
  2426. if (($item['type'] & MENU_LINKS_TO_PARENT) == MENU_LINKS_TO_PARENT) {
  2427. array_pop($active_trail);
  2428. }
  2429. foreach ($active_trail as $parent) {
  2430. $breadcrumb[] = l($parent['title'], $parent['href'], $parent['localized_options']);
  2431. }
  2432. }
  2433. return $breadcrumb;
  2434. }
  2435. /**
  2436. * Gets the title of the current page, as determined by the active trail.
  2437. */
  2438. function menu_get_active_title() {
  2439. $active_trail = menu_get_active_trail();
  2440. $local_task_title = NULL;
  2441. foreach (array_reverse($active_trail) as $item) {
  2442. // Local task titles are displayed as tabs and therefore should not be
  2443. // repeated as the page title. However, if the local task appears in a
  2444. // top-level menu, it is no longer a "local task" anymore (the front page
  2445. // of the site does not have tabs) so it is better to use the local task
  2446. // title in that case than to fall back on the front page link in the
  2447. // active trail (which is usually "Home" and would not make sense in this
  2448. // context).
  2449. if ((bool) ($item['type'] & MENU_IS_LOCAL_TASK)) {
  2450. // A local task title is being skipped; track it in case it needs to be
  2451. // used later.
  2452. $local_task_title = $item['title'];
  2453. }
  2454. else {
  2455. // This is not a local task, so use it for the page title (unless the
  2456. // conditions described above are met).
  2457. if (isset($local_task_title) && isset($item['href']) && $item['href'] == '<front>') {
  2458. return $local_task_title;
  2459. }
  2460. else {
  2461. return $item['title'];
  2462. }
  2463. }
  2464. }
  2465. }
  2466. /**
  2467. * Gets a translated, access-checked menu link that is ready for rendering.
  2468. *
  2469. * This function should never be called from within node_load() or any other
  2470. * function used as a menu object load function since an infinite recursion may
  2471. * occur.
  2472. *
  2473. * @param $mlid
  2474. * The mlid of the menu item.
  2475. *
  2476. * @return
  2477. * A menu link, with $item['access'] filled and link translated for
  2478. * rendering.
  2479. */
  2480. function menu_link_load($mlid) {
  2481. if (is_numeric($mlid)) {
  2482. $query = db_select('menu_links', 'ml');
  2483. $query->leftJoin('menu_router', 'm', 'm.path = ml.router_path');
  2484. $query->fields('ml');
  2485. // Weight should be taken from {menu_links}, not {menu_router}.
  2486. $query->addField('ml', 'weight', 'link_weight');
  2487. $query->fields('m');
  2488. $query->condition('ml.mlid', $mlid);
  2489. if ($item = $query->execute()->fetchAssoc()) {
  2490. $item['weight'] = $item['link_weight'];
  2491. _menu_link_translate($item);
  2492. return $item;
  2493. }
  2494. }
  2495. return FALSE;
  2496. }
  2497. /**
  2498. * Clears the cached cached data for a single named menu.
  2499. */
  2500. function menu_cache_clear($menu_name = 'navigation') {
  2501. $cache_cleared = &drupal_static(__FUNCTION__, array());
  2502. if (empty($cache_cleared[$menu_name])) {
  2503. cache_clear_all('links:' . $menu_name . ':', 'cache_menu', TRUE);
  2504. $cache_cleared[$menu_name] = 1;
  2505. }
  2506. elseif ($cache_cleared[$menu_name] == 1) {
  2507. drupal_register_shutdown_function('cache_clear_all', 'links:' . $menu_name . ':', 'cache_menu', TRUE);
  2508. $cache_cleared[$menu_name] = 2;
  2509. }
  2510. // Also clear the menu system static caches.
  2511. menu_reset_static_cache();
  2512. }
  2513. /**
  2514. * Clears all cached menu data.
  2515. *
  2516. * This should be called any time broad changes
  2517. * might have been made to the router items or menu links.
  2518. */
  2519. function menu_cache_clear_all() {
  2520. cache_clear_all('*', 'cache_menu', TRUE);
  2521. menu_reset_static_cache();
  2522. }
  2523. /**
  2524. * Resets the menu system static cache.
  2525. */
  2526. function menu_reset_static_cache() {
  2527. drupal_static_reset('_menu_build_tree');
  2528. drupal_static_reset('menu_tree');
  2529. drupal_static_reset('menu_tree_all_data');
  2530. drupal_static_reset('menu_tree_page_data');
  2531. drupal_static_reset('menu_load_all');
  2532. drupal_static_reset('menu_link_get_preferred');
  2533. }
  2534. /**
  2535. * Checks whether a menu_rebuild() is necessary.
  2536. */
  2537. function _menu_check_rebuild() {
  2538. // To absolutely ensure that the menu rebuild is required, re-load the
  2539. // variables in case they were set by another process.
  2540. $variables = variable_initialize();
  2541. if (empty($variables['menu_rebuild_needed']) && !empty($variables['menu_masks'])) {
  2542. unset($GLOBALS['conf']['menu_rebuild_needed']);
  2543. $GLOBALS['conf']['menu_masks'] = $variables['menu_masks'];
  2544. return FALSE;
  2545. }
  2546. return TRUE;
  2547. }
  2548. /**
  2549. * Populates the database tables used by various menu functions.
  2550. *
  2551. * This function will clear and populate the {menu_router} table, add entries
  2552. * to {menu_links} for new router items, and then remove stale items from
  2553. * {menu_links}. If called from update.php or install.php, it will also
  2554. * schedule a call to itself on the first real page load from
  2555. * menu_execute_active_handler(), because the maintenance page environment
  2556. * is different and leaves stale data in the menu tables.
  2557. *
  2558. * @return
  2559. * TRUE if the menu was rebuilt, FALSE if another thread was rebuilding
  2560. * in parallel and the current thread just waited for completion.
  2561. */
  2562. function menu_rebuild() {
  2563. if (!lock_acquire('menu_rebuild')) {
  2564. // Wait for another request that is already doing this work.
  2565. // We choose to block here since otherwise the router item may not
  2566. // be available in menu_execute_active_handler() resulting in a 404.
  2567. lock_wait('menu_rebuild');
  2568. if (_menu_check_rebuild()) {
  2569. // If we get here and menu_masks was not set, then it is possible a menu
  2570. // is being reloaded, or that the process rebuilding the menu was unable
  2571. // to complete successfully. A missing menu_masks variable could result
  2572. // in a 404, so re-run the function.
  2573. return menu_rebuild();
  2574. }
  2575. return FALSE;
  2576. }
  2577. $transaction = db_transaction();
  2578. try {
  2579. list($menu, $masks) = menu_router_build();
  2580. _menu_router_save($menu, $masks);
  2581. _menu_navigation_links_rebuild($menu);
  2582. // Clear the menu, page and block caches.
  2583. menu_cache_clear_all();
  2584. _menu_clear_page_cache();
  2585. if (defined('MAINTENANCE_MODE')) {
  2586. variable_set('menu_rebuild_needed', TRUE);
  2587. }
  2588. else {
  2589. variable_del('menu_rebuild_needed');
  2590. }
  2591. }
  2592. catch (Exception $e) {
  2593. $transaction->rollback();
  2594. watchdog_exception('menu', $e);
  2595. }
  2596. // Explicitly commit the transaction now; this ensures that the database
  2597. // operations during the menu rebuild are committed before the lock is made
  2598. // available again, since locks may not always reside in the same database
  2599. // connection. The lock is acquired outside of the transaction so should also
  2600. // be released outside of it.
  2601. unset($transaction);
  2602. lock_release('menu_rebuild');
  2603. return TRUE;
  2604. }
  2605. /**
  2606. * Collects and alters the menu definitions.
  2607. */
  2608. function menu_router_build() {
  2609. // We need to manually call each module so that we can know which module
  2610. // a given item came from.
  2611. $callbacks = array();
  2612. foreach (module_implements('menu') as $module) {
  2613. $router_items = call_user_func($module . '_menu');
  2614. if (isset($router_items) && is_array($router_items)) {
  2615. foreach (array_keys($router_items) as $path) {
  2616. $router_items[$path]['module'] = $module;
  2617. }
  2618. $callbacks = array_merge($callbacks, $router_items);
  2619. }
  2620. }
  2621. // Alter the menu as defined in modules, keys are like user/%user.
  2622. drupal_alter('menu', $callbacks);
  2623. list($menu, $masks) = _menu_router_build($callbacks);
  2624. _menu_router_cache($menu);
  2625. return array($menu, $masks);
  2626. }
  2627. /**
  2628. * Stores the menu router if we have it in memory.
  2629. */
  2630. function _menu_router_cache($new_menu = NULL) {
  2631. $menu = &drupal_static(__FUNCTION__);
  2632. if (isset($new_menu)) {
  2633. $menu = $new_menu;
  2634. }
  2635. return $menu;
  2636. }
  2637. /**
  2638. * Gets the menu router.
  2639. */
  2640. function menu_get_router() {
  2641. // Check first if we have it in memory already.
  2642. $menu = _menu_router_cache();
  2643. if (empty($menu)) {
  2644. list($menu, $masks) = menu_router_build();
  2645. }
  2646. return $menu;
  2647. }
  2648. /**
  2649. * Builds a link from a router item.
  2650. */
  2651. function _menu_link_build($item) {
  2652. // Suggested items are disabled by default.
  2653. if ($item['type'] == MENU_SUGGESTED_ITEM) {
  2654. $item['hidden'] = 1;
  2655. }
  2656. // Hide all items that are not visible in the tree.
  2657. elseif (!($item['type'] & MENU_VISIBLE_IN_TREE)) {
  2658. $item['hidden'] = -1;
  2659. }
  2660. // Note, we set this as 'system', so that we can be sure to distinguish all
  2661. // the menu links generated automatically from entries in {menu_router}.
  2662. $item['module'] = 'system';
  2663. $item += array(
  2664. 'menu_name' => 'navigation',
  2665. 'link_title' => $item['title'],
  2666. 'link_path' => $item['path'],
  2667. 'hidden' => 0,
  2668. 'options' => empty($item['description']) ? array() : array('attributes' => array('title' => $item['description'])),
  2669. );
  2670. return $item;
  2671. }
  2672. /**
  2673. * Builds menu links for the items in the menu router.
  2674. */
  2675. function _menu_navigation_links_rebuild($menu) {
  2676. // Add normal and suggested items as links.
  2677. $menu_links = array();
  2678. foreach ($menu as $path => $item) {
  2679. if ($item['_visible']) {
  2680. $menu_links[$path] = $item;
  2681. $sort[$path] = $item['_number_parts'];
  2682. }
  2683. }
  2684. if ($menu_links) {
  2685. // Keep an array of processed menu links, to allow menu_link_save() to
  2686. // check this for parents instead of querying the database.
  2687. $parent_candidates = array();
  2688. // Make sure no child comes before its parent.
  2689. array_multisort($sort, SORT_NUMERIC, $menu_links);
  2690. foreach ($menu_links as $key => $item) {
  2691. $existing_item = db_select('menu_links')
  2692. ->fields('menu_links')
  2693. ->condition('link_path', $item['path'])
  2694. ->condition('module', 'system')
  2695. ->execute()->fetchAssoc();
  2696. if ($existing_item) {
  2697. $item['mlid'] = $existing_item['mlid'];
  2698. // A change in hook_menu may move the link to a different menu
  2699. if (empty($item['menu_name']) || ($item['menu_name'] == $existing_item['menu_name'])) {
  2700. $item['menu_name'] = $existing_item['menu_name'];
  2701. $item['plid'] = $existing_item['plid'];
  2702. }
  2703. else {
  2704. // It moved to a new menu. Let menu_link_save() try to find a new
  2705. // parent based on the path.
  2706. unset($item['plid']);
  2707. }
  2708. $item['has_children'] = $existing_item['has_children'];
  2709. $item['updated'] = $existing_item['updated'];
  2710. }
  2711. if ($existing_item && $existing_item['customized']) {
  2712. $parent_candidates[$existing_item['mlid']] = $existing_item;
  2713. }
  2714. else {
  2715. $item = _menu_link_build($item);
  2716. menu_link_save($item, $existing_item, $parent_candidates);
  2717. $parent_candidates[$item['mlid']] = $item;
  2718. unset($menu_links[$key]);
  2719. }
  2720. }
  2721. }
  2722. $paths = array_keys($menu);
  2723. // Updated and customized items whose router paths are gone need new ones.
  2724. $result = db_select('menu_links', NULL, array('fetch' => PDO::FETCH_ASSOC))
  2725. ->fields('menu_links', array(
  2726. 'link_path',
  2727. 'mlid',
  2728. 'router_path',
  2729. 'updated',
  2730. ))
  2731. ->condition(db_or()
  2732. ->condition('updated', 1)
  2733. ->condition(db_and()
  2734. ->condition('router_path', $paths, 'NOT IN')
  2735. ->condition('external', 0)
  2736. ->condition('customized', 1)
  2737. )
  2738. )
  2739. ->execute();
  2740. foreach ($result as $item) {
  2741. $router_path = _menu_find_router_path($item['link_path']);
  2742. if (!empty($router_path) && ($router_path != $item['router_path'] || $item['updated'])) {
  2743. // If the router path and the link path matches, it's surely a working
  2744. // item, so we clear the updated flag.
  2745. $updated = $item['updated'] && $router_path != $item['link_path'];
  2746. db_update('menu_links')
  2747. ->fields(array(
  2748. 'router_path' => $router_path,
  2749. 'updated' => (int) $updated,
  2750. ))
  2751. ->condition('mlid', $item['mlid'])
  2752. ->execute();
  2753. }
  2754. }
  2755. // Find any item whose router path does not exist any more.
  2756. $result = db_select('menu_links')
  2757. ->fields('menu_links')
  2758. ->condition('router_path', $paths, 'NOT IN')
  2759. ->condition('external', 0)
  2760. ->condition('updated', 0)
  2761. ->condition('customized', 0)
  2762. ->orderBy('depth', 'DESC')
  2763. ->execute();
  2764. // Remove all such items. Starting from those with the greatest depth will
  2765. // minimize the amount of re-parenting done by menu_link_delete().
  2766. foreach ($result as $item) {
  2767. _menu_delete_item($item, TRUE);
  2768. }
  2769. }
  2770. /**
  2771. * Clones an array of menu links.
  2772. *
  2773. * @param $links
  2774. * An array of menu links to clone.
  2775. * @param $menu_name
  2776. * (optional) The name of a menu that the links will be cloned for. If not
  2777. * set, the cloned links will be in the same menu as the original set of
  2778. * links that were passed in.
  2779. *
  2780. * @return
  2781. * An array of menu links with the same properties as the passed-in array,
  2782. * but with the link identifiers removed so that a new link will be created
  2783. * when any of them is passed in to menu_link_save().
  2784. *
  2785. * @see menu_link_save()
  2786. */
  2787. function menu_links_clone($links, $menu_name = NULL) {
  2788. foreach ($links as &$link) {
  2789. unset($link['mlid']);
  2790. unset($link['plid']);
  2791. if (isset($menu_name)) {
  2792. $link['menu_name'] = $menu_name;
  2793. }
  2794. }
  2795. return $links;
  2796. }
  2797. /**
  2798. * Returns an array containing all links for a menu.
  2799. *
  2800. * @param $menu_name
  2801. * The name of the menu whose links should be returned.
  2802. *
  2803. * @return
  2804. * An array of menu links.
  2805. */
  2806. function menu_load_links($menu_name) {
  2807. $links = db_select('menu_links', 'ml', array('fetch' => PDO::FETCH_ASSOC))
  2808. ->fields('ml')
  2809. ->condition('ml.menu_name', $menu_name)
  2810. // Order by weight so as to be helpful for menus that are only one level
  2811. // deep.
  2812. ->orderBy('weight')
  2813. ->execute()
  2814. ->fetchAll();
  2815. foreach ($links as &$link) {
  2816. $link['options'] = unserialize($link['options']);
  2817. }
  2818. return $links;
  2819. }
  2820. /**
  2821. * Deletes all links for a menu.
  2822. *
  2823. * @param $menu_name
  2824. * The name of the menu whose links will be deleted.
  2825. */
  2826. function menu_delete_links($menu_name) {
  2827. $links = menu_load_links($menu_name);
  2828. foreach ($links as $link) {
  2829. // To speed up the deletion process, we reset some link properties that
  2830. // would trigger re-parenting logic in _menu_delete_item() and
  2831. // _menu_update_parental_status().
  2832. $link['has_children'] = FALSE;
  2833. $link['plid'] = 0;
  2834. _menu_delete_item($link);
  2835. }
  2836. }
  2837. /**
  2838. * Delete one or several menu links.
  2839. *
  2840. * @param $mlid
  2841. * A valid menu link mlid or NULL. If NULL, $path is used.
  2842. * @param $path
  2843. * The path to the menu items to be deleted. $mlid must be NULL.
  2844. */
  2845. function menu_link_delete($mlid, $path = NULL) {
  2846. if (isset($mlid)) {
  2847. _menu_delete_item(db_query("SELECT * FROM {menu_links} WHERE mlid = :mlid", array(':mlid' => $mlid))->fetchAssoc());
  2848. }
  2849. else {
  2850. $result = db_query("SELECT * FROM {menu_links} WHERE link_path = :link_path", array(':link_path' => $path));
  2851. foreach ($result as $link) {
  2852. _menu_delete_item($link);
  2853. }
  2854. }
  2855. }
  2856. /**
  2857. * Deletes a single menu link.
  2858. *
  2859. * @param $item
  2860. * Item to be deleted.
  2861. * @param $force
  2862. * Forces deletion. Internal use only, setting to TRUE is discouraged.
  2863. *
  2864. * @see menu_link_delete()
  2865. */
  2866. function _menu_delete_item($item, $force = FALSE) {
  2867. $item = is_object($item) ? get_object_vars($item) : $item;
  2868. if ($item && ($item['module'] != 'system' || $item['updated'] || $force)) {
  2869. // Children get re-attached to the item's parent.
  2870. if ($item['has_children']) {
  2871. $result = db_query("SELECT mlid FROM {menu_links} WHERE plid = :plid", array(':plid' => $item['mlid']));
  2872. foreach ($result as $m) {
  2873. $child = menu_link_load($m->mlid);
  2874. $child['plid'] = $item['plid'];
  2875. menu_link_save($child);
  2876. }
  2877. }
  2878. // Notify modules we are deleting the item.
  2879. module_invoke_all('menu_link_delete', $item);
  2880. db_delete('menu_links')->condition('mlid', $item['mlid'])->execute();
  2881. // Update the has_children status of the parent.
  2882. _menu_update_parental_status($item);
  2883. menu_cache_clear($item['menu_name']);
  2884. _menu_clear_page_cache();
  2885. }
  2886. }
  2887. /**
  2888. * Saves a menu link.
  2889. *
  2890. * After calling this function, rebuild the menu cache using
  2891. * menu_cache_clear_all().
  2892. *
  2893. * @param $item
  2894. * An associative array representing a menu link item, with elements:
  2895. * - link_path: (required) The path of the menu item, which should be
  2896. * normalized first by calling drupal_get_normal_path() on it.
  2897. * - link_title: (required) Title to appear in menu for the link.
  2898. * - menu_name: (optional) The machine name of the menu for the link.
  2899. * Defaults to 'navigation'.
  2900. * - weight: (optional) Integer to determine position in menu. Default is 0.
  2901. * - expanded: (optional) Boolean that determines if the item is expanded.
  2902. * - options: (optional) An array of options, see l() for more.
  2903. * - mlid: (optional) Menu link identifier, the primary integer key for each
  2904. * menu link. Can be set to an existing value, or to 0 or NULL
  2905. * to insert a new link.
  2906. * - plid: (optional) The mlid of the parent.
  2907. * - router_path: (optional) The path of the relevant router item.
  2908. * @param $existing_item
  2909. * Optional, the current record from the {menu_links} table as an array.
  2910. * @param $parent_candidates
  2911. * Optional array of menu links keyed by mlid. Used by
  2912. * _menu_navigation_links_rebuild() only.
  2913. *
  2914. * @return
  2915. * The mlid of the saved menu link, or FALSE if the menu link could not be
  2916. * saved.
  2917. */
  2918. function menu_link_save(&$item, $existing_item = array(), $parent_candidates = array()) {
  2919. drupal_alter('menu_link', $item);
  2920. // This is the easiest way to handle the unique internal path '<front>',
  2921. // since a path marked as external does not need to match a router path.
  2922. $item['external'] = (url_is_external($item['link_path']) || $item['link_path'] == '<front>') ? 1 : 0;
  2923. // Load defaults.
  2924. $item += array(
  2925. 'menu_name' => 'navigation',
  2926. 'weight' => 0,
  2927. 'link_title' => '',
  2928. 'hidden' => 0,
  2929. 'has_children' => 0,
  2930. 'expanded' => 0,
  2931. 'options' => array(),
  2932. 'module' => 'menu',
  2933. 'customized' => 0,
  2934. 'updated' => 0,
  2935. );
  2936. if (isset($item['mlid'])) {
  2937. if (!$existing_item) {
  2938. $existing_item = db_query('SELECT * FROM {menu_links} WHERE mlid = :mlid', array('mlid' => $item['mlid']))->fetchAssoc();
  2939. }
  2940. if ($existing_item) {
  2941. $existing_item['options'] = unserialize($existing_item['options']);
  2942. }
  2943. }
  2944. else {
  2945. $existing_item = FALSE;
  2946. }
  2947. // Try to find a parent link. If found, assign it and derive its menu.
  2948. $parent = _menu_link_find_parent($item, $parent_candidates);
  2949. if (!empty($parent['mlid'])) {
  2950. $item['plid'] = $parent['mlid'];
  2951. $item['menu_name'] = $parent['menu_name'];
  2952. }
  2953. // If no corresponding parent link was found, move the link to the top-level.
  2954. else {
  2955. $item['plid'] = 0;
  2956. }
  2957. $menu_name = $item['menu_name'];
  2958. if (!$existing_item) {
  2959. $item['mlid'] = db_insert('menu_links')
  2960. ->fields(array(
  2961. 'menu_name' => $item['menu_name'],
  2962. 'plid' => $item['plid'],
  2963. 'link_path' => $item['link_path'],
  2964. 'hidden' => $item['hidden'],
  2965. 'external' => $item['external'],
  2966. 'has_children' => $item['has_children'],
  2967. 'expanded' => $item['expanded'],
  2968. 'weight' => $item['weight'],
  2969. 'module' => $item['module'],
  2970. 'link_title' => $item['link_title'],
  2971. 'options' => serialize($item['options']),
  2972. 'customized' => $item['customized'],
  2973. 'updated' => $item['updated'],
  2974. ))
  2975. ->execute();
  2976. }
  2977. // Directly fill parents for top-level links.
  2978. if ($item['plid'] == 0) {
  2979. $item['p1'] = $item['mlid'];
  2980. for ($i = 2; $i <= MENU_MAX_DEPTH; $i++) {
  2981. $item["p$i"] = 0;
  2982. }
  2983. $item['depth'] = 1;
  2984. }
  2985. // Otherwise, ensure that this link's depth is not beyond the maximum depth
  2986. // and fill parents based on the parent link.
  2987. else {
  2988. if ($item['has_children'] && $existing_item) {
  2989. $limit = MENU_MAX_DEPTH - menu_link_children_relative_depth($existing_item) - 1;
  2990. }
  2991. else {
  2992. $limit = MENU_MAX_DEPTH - 1;
  2993. }
  2994. if ($parent['depth'] > $limit) {
  2995. return FALSE;
  2996. }
  2997. $item['depth'] = $parent['depth'] + 1;
  2998. _menu_link_parents_set($item, $parent);
  2999. }
  3000. // Need to check both plid and menu_name, since plid can be 0 in any menu.
  3001. if ($existing_item && ($item['plid'] != $existing_item['plid'] || $menu_name != $existing_item['menu_name'])) {
  3002. _menu_link_move_children($item, $existing_item);
  3003. }
  3004. // Find the router_path.
  3005. if (empty($item['router_path']) || !$existing_item || ($existing_item['link_path'] != $item['link_path'])) {
  3006. if ($item['external']) {
  3007. $item['router_path'] = '';
  3008. }
  3009. else {
  3010. // Find the router path which will serve this path.
  3011. $item['parts'] = explode('/', $item['link_path'], MENU_MAX_PARTS);
  3012. $item['router_path'] = _menu_find_router_path($item['link_path']);
  3013. }
  3014. }
  3015. // If every value in $existing_item is the same in the $item, there is no
  3016. // reason to run the update queries or clear the caches. We use
  3017. // array_intersect_key() with the $item as the first parameter because
  3018. // $item may have additional keys left over from building a router entry.
  3019. // The intersect removes the extra keys, allowing a meaningful comparison.
  3020. if (!$existing_item || (array_intersect_key($item, $existing_item) != $existing_item)) {
  3021. db_update('menu_links')
  3022. ->fields(array(
  3023. 'menu_name' => $item['menu_name'],
  3024. 'plid' => $item['plid'],
  3025. 'link_path' => $item['link_path'],
  3026. 'router_path' => $item['router_path'],
  3027. 'hidden' => $item['hidden'],
  3028. 'external' => $item['external'],
  3029. 'has_children' => $item['has_children'],
  3030. 'expanded' => $item['expanded'],
  3031. 'weight' => $item['weight'],
  3032. 'depth' => $item['depth'],
  3033. 'p1' => $item['p1'],
  3034. 'p2' => $item['p2'],
  3035. 'p3' => $item['p3'],
  3036. 'p4' => $item['p4'],
  3037. 'p5' => $item['p5'],
  3038. 'p6' => $item['p6'],
  3039. 'p7' => $item['p7'],
  3040. 'p8' => $item['p8'],
  3041. 'p9' => $item['p9'],
  3042. 'module' => $item['module'],
  3043. 'link_title' => $item['link_title'],
  3044. 'options' => serialize($item['options']),
  3045. 'customized' => $item['customized'],
  3046. ))
  3047. ->condition('mlid', $item['mlid'])
  3048. ->execute();
  3049. // Check the has_children status of the parent.
  3050. _menu_update_parental_status($item);
  3051. menu_cache_clear($menu_name);
  3052. if ($existing_item && $menu_name != $existing_item['menu_name']) {
  3053. menu_cache_clear($existing_item['menu_name']);
  3054. }
  3055. // Notify modules we have acted on a menu item.
  3056. $hook = 'menu_link_insert';
  3057. if ($existing_item) {
  3058. $hook = 'menu_link_update';
  3059. }
  3060. module_invoke_all($hook, $item);
  3061. // Now clear the cache.
  3062. _menu_clear_page_cache();
  3063. }
  3064. return $item['mlid'];
  3065. }
  3066. /**
  3067. * Finds a possible parent for a given menu link.
  3068. *
  3069. * Because the parent of a given link might not exist anymore in the database,
  3070. * we apply a set of heuristics to determine a proper parent:
  3071. *
  3072. * - use the passed parent link if specified and existing.
  3073. * - else, use the first existing link down the previous link hierarchy
  3074. * - else, for system menu links (derived from hook_menu()), reparent
  3075. * based on the path hierarchy.
  3076. *
  3077. * @param $menu_link
  3078. * A menu link.
  3079. * @param $parent_candidates
  3080. * An array of menu links keyed by mlid.
  3081. *
  3082. * @return
  3083. * A menu link structure of the possible parent or FALSE if no valid parent
  3084. * has been found.
  3085. */
  3086. function _menu_link_find_parent($menu_link, $parent_candidates = array()) {
  3087. $parent = FALSE;
  3088. // This item is explicitely top-level, skip the rest of the parenting.
  3089. if (isset($menu_link['plid']) && empty($menu_link['plid'])) {
  3090. return $parent;
  3091. }
  3092. // If we have a parent link ID, try to use that.
  3093. $candidates = array();
  3094. if (isset($menu_link['plid'])) {
  3095. $candidates[] = $menu_link['plid'];
  3096. }
  3097. // Else, if we have a link hierarchy try to find a valid parent in there.
  3098. if (!empty($menu_link['depth']) && $menu_link['depth'] > 1) {
  3099. for ($depth = $menu_link['depth'] - 1; $depth >= 1; $depth--) {
  3100. $candidates[] = $menu_link['p' . $depth];
  3101. }
  3102. }
  3103. foreach ($candidates as $mlid) {
  3104. if (isset($parent_candidates[$mlid])) {
  3105. $parent = $parent_candidates[$mlid];
  3106. }
  3107. else {
  3108. $parent = db_query("SELECT * FROM {menu_links} WHERE mlid = :mlid", array(':mlid' => $mlid))->fetchAssoc();
  3109. }
  3110. if ($parent) {
  3111. return $parent;
  3112. }
  3113. }
  3114. // If everything else failed, try to derive the parent from the path
  3115. // hierarchy. This only makes sense for links derived from menu router
  3116. // items (ie. from hook_menu()).
  3117. if ($menu_link['module'] == 'system') {
  3118. $query = db_select('menu_links');
  3119. $query->condition('module', 'system');
  3120. // We always respect the link's 'menu_name'; inheritance for router items is
  3121. // ensured in _menu_router_build().
  3122. $query->condition('menu_name', $menu_link['menu_name']);
  3123. // Find the parent - it must be unique.
  3124. $parent_path = $menu_link['link_path'];
  3125. do {
  3126. $parent = FALSE;
  3127. $parent_path = substr($parent_path, 0, strrpos($parent_path, '/'));
  3128. $new_query = clone $query;
  3129. $new_query->condition('link_path', $parent_path);
  3130. // Only valid if we get a unique result.
  3131. if ($new_query->countQuery()->execute()->fetchField() == 1) {
  3132. $parent = $new_query->fields('menu_links')->execute()->fetchAssoc();
  3133. }
  3134. } while ($parent === FALSE && $parent_path);
  3135. }
  3136. return $parent;
  3137. }
  3138. /**
  3139. * Clears the page and block caches at most twice per page load.
  3140. */
  3141. function _menu_clear_page_cache() {
  3142. $cache_cleared = &drupal_static(__FUNCTION__, 0);
  3143. // Clear the page and block caches, but at most twice, including at
  3144. // the end of the page load when there are multiple links saved or deleted.
  3145. if ($cache_cleared == 0) {
  3146. cache_clear_all();
  3147. // Keep track of which menus have expanded items.
  3148. _menu_set_expanded_menus();
  3149. $cache_cleared = 1;
  3150. }
  3151. elseif ($cache_cleared == 1) {
  3152. drupal_register_shutdown_function('cache_clear_all');
  3153. // Keep track of which menus have expanded items.
  3154. drupal_register_shutdown_function('_menu_set_expanded_menus');
  3155. $cache_cleared = 2;
  3156. }
  3157. }
  3158. /**
  3159. * Updates a list of menus with expanded items.
  3160. */
  3161. function _menu_set_expanded_menus() {
  3162. $names = db_query("SELECT menu_name FROM {menu_links} WHERE expanded <> 0 GROUP BY menu_name")->fetchCol();
  3163. variable_set('menu_expanded', $names);
  3164. }
  3165. /**
  3166. * Finds the router path which will serve this path.
  3167. *
  3168. * @param $link_path
  3169. * The path for we are looking up its router path.
  3170. *
  3171. * @return
  3172. * A path from $menu keys or empty if $link_path points to a nonexisting
  3173. * place.
  3174. */
  3175. function _menu_find_router_path($link_path) {
  3176. // $menu will only have data during a menu rebuild.
  3177. $menu = _menu_router_cache();
  3178. $router_path = $link_path;
  3179. $parts = explode('/', $link_path, MENU_MAX_PARTS);
  3180. $ancestors = menu_get_ancestors($parts);
  3181. if (empty($menu)) {
  3182. // Not during a menu rebuild, so look up in the database.
  3183. $router_path = (string) db_select('menu_router')
  3184. ->fields('menu_router', array('path'))
  3185. ->condition('path', $ancestors, 'IN')
  3186. ->orderBy('fit', 'DESC')
  3187. ->range(0, 1)
  3188. ->execute()->fetchField();
  3189. }
  3190. elseif (!isset($menu[$router_path])) {
  3191. // Add an empty router path as a fallback.
  3192. $ancestors[] = '';
  3193. foreach ($ancestors as $key => $router_path) {
  3194. if (isset($menu[$router_path])) {
  3195. // Exit the loop leaving $router_path as the first match.
  3196. break;
  3197. }
  3198. }
  3199. // If we did not find the path, $router_path will be the empty string
  3200. // at the end of $ancestors.
  3201. }
  3202. return $router_path;
  3203. }
  3204. /**
  3205. * Inserts, updates, or deletes an uncustomized menu link related to a module.
  3206. *
  3207. * @param $module
  3208. * The name of the module.
  3209. * @param $op
  3210. * Operation to perform: insert, update or delete.
  3211. * @param $link_path
  3212. * The path this link points to.
  3213. * @param $link_title
  3214. * Title of the link to insert or new title to update the link to.
  3215. * Unused for delete.
  3216. *
  3217. * @return
  3218. * The insert op returns the mlid of the new item. Others op return NULL.
  3219. */
  3220. function menu_link_maintain($module, $op, $link_path, $link_title) {
  3221. switch ($op) {
  3222. case 'insert':
  3223. $menu_link = array(
  3224. 'link_title' => $link_title,
  3225. 'link_path' => $link_path,
  3226. 'module' => $module,
  3227. );
  3228. return menu_link_save($menu_link);
  3229. break;
  3230. case 'update':
  3231. $result = db_query("SELECT * FROM {menu_links} WHERE link_path = :link_path AND module = :module AND customized = 0", array(':link_path' => $link_path, ':module' => $module))->fetchAll(PDO::FETCH_ASSOC);
  3232. foreach ($result as $link) {
  3233. $link['link_title'] = $link_title;
  3234. $link['options'] = unserialize($link['options']);
  3235. menu_link_save($link);
  3236. }
  3237. break;
  3238. case 'delete':
  3239. menu_link_delete(NULL, $link_path);
  3240. break;
  3241. }
  3242. }
  3243. /**
  3244. * Finds the depth of an item's children relative to its depth.
  3245. *
  3246. * For example, if the item has a depth of 2, and the maximum of any child in
  3247. * the menu link tree is 5, the relative depth is 3.
  3248. *
  3249. * @param $item
  3250. * An array representing a menu link item.
  3251. *
  3252. * @return
  3253. * The relative depth, or zero.
  3254. *
  3255. */
  3256. function menu_link_children_relative_depth($item) {
  3257. $query = db_select('menu_links');
  3258. $query->addField('menu_links', 'depth');
  3259. $query->condition('menu_name', $item['menu_name']);
  3260. $query->orderBy('depth', 'DESC');
  3261. $query->range(0, 1);
  3262. $i = 1;
  3263. $p = 'p1';
  3264. while ($i <= MENU_MAX_DEPTH && $item[$p]) {
  3265. $query->condition($p, $item[$p]);
  3266. $p = 'p' . ++$i;
  3267. }
  3268. $max_depth = $query->execute()->fetchField();
  3269. return ($max_depth > $item['depth']) ? $max_depth - $item['depth'] : 0;
  3270. }
  3271. /**
  3272. * Updates the children of a menu link that is being moved.
  3273. *
  3274. * The menu name, parents (p1 - p6), and depth are updated for all children of
  3275. * the link, and the has_children status of the previous parent is updated.
  3276. */
  3277. function _menu_link_move_children($item, $existing_item) {
  3278. $query = db_update('menu_links');
  3279. $query->fields(array('menu_name' => $item['menu_name']));
  3280. $p = 'p1';
  3281. $expressions = array();
  3282. for ($i = 1; $i <= $item['depth']; $p = 'p' . ++$i) {
  3283. $expressions[] = array($p, ":p_$i", array(":p_$i" => $item[$p]));
  3284. }
  3285. $j = $existing_item['depth'] + 1;
  3286. while ($i <= MENU_MAX_DEPTH && $j <= MENU_MAX_DEPTH) {
  3287. $expressions[] = array('p' . $i++, 'p' . $j++, array());
  3288. }
  3289. while ($i <= MENU_MAX_DEPTH) {
  3290. $expressions[] = array('p' . $i++, 0, array());
  3291. }
  3292. $shift = $item['depth'] - $existing_item['depth'];
  3293. if ($shift > 0) {
  3294. // The order of expressions must be reversed so the new values don't
  3295. // overwrite the old ones before they can be used because "Single-table
  3296. // UPDATE assignments are generally evaluated from left to right"
  3297. // see: http://dev.mysql.com/doc/refman/5.0/en/update.html
  3298. $expressions = array_reverse($expressions);
  3299. }
  3300. foreach ($expressions as $expression) {
  3301. $query->expression($expression[0], $expression[1], $expression[2]);
  3302. }
  3303. $query->expression('depth', 'depth + :depth', array(':depth' => $shift));
  3304. $query->condition('menu_name', $existing_item['menu_name']);
  3305. $p = 'p1';
  3306. for ($i = 1; $i <= MENU_MAX_DEPTH && $existing_item[$p]; $p = 'p' . ++$i) {
  3307. $query->condition($p, $existing_item[$p]);
  3308. }
  3309. $query->execute();
  3310. // Check the has_children status of the parent, while excluding this item.
  3311. _menu_update_parental_status($existing_item, TRUE);
  3312. }
  3313. /**
  3314. * Checks and updates the 'has_children' status for the parent of a link.
  3315. */
  3316. function _menu_update_parental_status($item, $exclude = FALSE) {
  3317. // If plid == 0, there is nothing to update.
  3318. if ($item['plid']) {
  3319. // Check if at least one visible child exists in the table.
  3320. $query = db_select('menu_links');
  3321. $query->addField('menu_links', 'mlid');
  3322. $query->condition('menu_name', $item['menu_name']);
  3323. $query->condition('hidden', 0);
  3324. $query->condition('plid', $item['plid']);
  3325. $query->range(0, 1);
  3326. if ($exclude) {
  3327. $query->condition('mlid', $item['mlid'], '<>');
  3328. }
  3329. $parent_has_children = ((bool) $query->execute()->fetchField()) ? 1 : 0;
  3330. db_update('menu_links')
  3331. ->fields(array('has_children' => $parent_has_children))
  3332. ->condition('mlid', $item['plid'])
  3333. ->execute();
  3334. }
  3335. }
  3336. /**
  3337. * Sets the p1 through p9 values for a menu link being saved.
  3338. */
  3339. function _menu_link_parents_set(&$item, $parent) {
  3340. $i = 1;
  3341. while ($i < $item['depth']) {
  3342. $p = 'p' . $i++;
  3343. $item[$p] = $parent[$p];
  3344. }
  3345. $p = 'p' . $i++;
  3346. // The parent (p1 - p9) corresponding to the depth always equals the mlid.
  3347. $item[$p] = $item['mlid'];
  3348. while ($i <= MENU_MAX_DEPTH) {
  3349. $p = 'p' . $i++;
  3350. $item[$p] = 0;
  3351. }
  3352. }
  3353. /**
  3354. * Builds the router table based on the data from hook_menu().
  3355. */
  3356. function _menu_router_build($callbacks) {
  3357. // First pass: separate callbacks from paths, making paths ready for
  3358. // matching. Calculate fitness, and fill some default values.
  3359. $menu = array();
  3360. $masks = array();
  3361. foreach ($callbacks as $path => $item) {
  3362. $load_functions = array();
  3363. $to_arg_functions = array();
  3364. $fit = 0;
  3365. $move = FALSE;
  3366. $parts = explode('/', $path, MENU_MAX_PARTS);
  3367. $number_parts = count($parts);
  3368. // We store the highest index of parts here to save some work in the fit
  3369. // calculation loop.
  3370. $slashes = $number_parts - 1;
  3371. // Extract load and to_arg functions.
  3372. foreach ($parts as $k => $part) {
  3373. $match = FALSE;
  3374. // Look for wildcards in the form allowed to be used in PHP functions,
  3375. // because we are using these to construct the load function names.
  3376. if (preg_match('/^%(|' . DRUPAL_PHP_FUNCTION_PATTERN . ')$/', $part, $matches)) {
  3377. if (empty($matches[1])) {
  3378. $match = TRUE;
  3379. $load_functions[$k] = NULL;
  3380. }
  3381. else {
  3382. if (function_exists($matches[1] . '_to_arg')) {
  3383. $to_arg_functions[$k] = $matches[1] . '_to_arg';
  3384. $load_functions[$k] = NULL;
  3385. $match = TRUE;
  3386. }
  3387. if (function_exists($matches[1] . '_load')) {
  3388. $function = $matches[1] . '_load';
  3389. // Create an array of arguments that will be passed to the _load
  3390. // function when this menu path is checked, if 'load arguments'
  3391. // exists.
  3392. $load_functions[$k] = isset($item['load arguments']) ? array($function => $item['load arguments']) : $function;
  3393. $match = TRUE;
  3394. }
  3395. }
  3396. }
  3397. if ($match) {
  3398. $parts[$k] = '%';
  3399. }
  3400. else {
  3401. $fit |= 1 << ($slashes - $k);
  3402. }
  3403. }
  3404. if ($fit) {
  3405. $move = TRUE;
  3406. }
  3407. else {
  3408. // If there is no %, it fits maximally.
  3409. $fit = (1 << $number_parts) - 1;
  3410. }
  3411. $masks[$fit] = 1;
  3412. $item['_load_functions'] = $load_functions;
  3413. $item['to_arg_functions'] = empty($to_arg_functions) ? '' : serialize($to_arg_functions);
  3414. $item += array(
  3415. 'title' => '',
  3416. 'weight' => 0,
  3417. 'type' => MENU_NORMAL_ITEM,
  3418. 'module' => '',
  3419. '_number_parts' => $number_parts,
  3420. '_parts' => $parts,
  3421. '_fit' => $fit,
  3422. );
  3423. $item += array(
  3424. '_visible' => (bool) ($item['type'] & MENU_VISIBLE_IN_BREADCRUMB),
  3425. '_tab' => (bool) ($item['type'] & MENU_IS_LOCAL_TASK),
  3426. );
  3427. if ($move) {
  3428. $new_path = implode('/', $item['_parts']);
  3429. $menu[$new_path] = $item;
  3430. $sort[$new_path] = $number_parts;
  3431. }
  3432. else {
  3433. $menu[$path] = $item;
  3434. $sort[$path] = $number_parts;
  3435. }
  3436. }
  3437. array_multisort($sort, SORT_NUMERIC, $menu);
  3438. // Apply inheritance rules.
  3439. foreach ($menu as $path => $v) {
  3440. $item = &$menu[$path];
  3441. if (!$item['_tab']) {
  3442. // Non-tab items.
  3443. $item['tab_parent'] = '';
  3444. $item['tab_root'] = $path;
  3445. }
  3446. // If not specified, assign the default tab type for local tasks.
  3447. elseif (!isset($item['context'])) {
  3448. $item['context'] = MENU_CONTEXT_PAGE;
  3449. }
  3450. for ($i = $item['_number_parts'] - 1; $i; $i--) {
  3451. $parent_path = implode('/', array_slice($item['_parts'], 0, $i));
  3452. if (isset($menu[$parent_path])) {
  3453. $parent = &$menu[$parent_path];
  3454. // If we have no menu name, try to inherit it from parent items.
  3455. if (!isset($item['menu_name'])) {
  3456. // If the parent item of this item does not define a menu name (and no
  3457. // previous iteration assigned one already), try to find the menu name
  3458. // of the parent item in the currently stored menu links.
  3459. if (!isset($parent['menu_name'])) {
  3460. $menu_name = db_query("SELECT menu_name FROM {menu_links} WHERE router_path = :router_path AND module = 'system'", array(':router_path' => $parent_path))->fetchField();
  3461. if ($menu_name) {
  3462. $parent['menu_name'] = $menu_name;
  3463. }
  3464. }
  3465. // If the parent item defines a menu name, inherit it.
  3466. if (!empty($parent['menu_name'])) {
  3467. $item['menu_name'] = $parent['menu_name'];
  3468. }
  3469. }
  3470. if (!isset($item['tab_parent'])) {
  3471. // Parent stores the parent of the path.
  3472. $item['tab_parent'] = $parent_path;
  3473. }
  3474. if (!isset($item['tab_root']) && !$parent['_tab']) {
  3475. $item['tab_root'] = $parent_path;
  3476. }
  3477. // If an access callback is not found for a default local task we use
  3478. // the callback from the parent, since we expect them to be identical.
  3479. // In all other cases, the access parameters must be specified.
  3480. if (($item['type'] == MENU_DEFAULT_LOCAL_TASK) && !isset($item['access callback']) && isset($parent['access callback'])) {
  3481. $item['access callback'] = $parent['access callback'];
  3482. if (!isset($item['access arguments']) && isset($parent['access arguments'])) {
  3483. $item['access arguments'] = $parent['access arguments'];
  3484. }
  3485. }
  3486. // Same for page callbacks.
  3487. if (!isset($item['page callback']) && isset($parent['page callback'])) {
  3488. $item['page callback'] = $parent['page callback'];
  3489. if (!isset($item['page arguments']) && isset($parent['page arguments'])) {
  3490. $item['page arguments'] = $parent['page arguments'];
  3491. }
  3492. if (!isset($item['file path']) && isset($parent['file path'])) {
  3493. $item['file path'] = $parent['file path'];
  3494. }
  3495. if (!isset($item['file']) && isset($parent['file'])) {
  3496. $item['file'] = $parent['file'];
  3497. if (empty($item['file path']) && isset($item['module']) && isset($parent['module']) && $item['module'] != $parent['module']) {
  3498. $item['file path'] = drupal_get_path('module', $parent['module']);
  3499. }
  3500. }
  3501. }
  3502. // Same for delivery callbacks.
  3503. if (!isset($item['delivery callback']) && isset($parent['delivery callback'])) {
  3504. $item['delivery callback'] = $parent['delivery callback'];
  3505. }
  3506. // Same for theme callbacks.
  3507. if (!isset($item['theme callback']) && isset($parent['theme callback'])) {
  3508. $item['theme callback'] = $parent['theme callback'];
  3509. if (!isset($item['theme arguments']) && isset($parent['theme arguments'])) {
  3510. $item['theme arguments'] = $parent['theme arguments'];
  3511. }
  3512. }
  3513. // Same for load arguments: if a loader doesn't have any explict
  3514. // arguments, try to find arguments in the parent.
  3515. if (!isset($item['load arguments'])) {
  3516. foreach ($item['_load_functions'] as $k => $function) {
  3517. // This loader doesn't have any explict arguments...
  3518. if (!is_array($function)) {
  3519. // ... check the parent for a loader at the same position
  3520. // using the same function name and defining arguments...
  3521. if (isset($parent['_load_functions'][$k]) && is_array($parent['_load_functions'][$k]) && key($parent['_load_functions'][$k]) === $function) {
  3522. // ... and inherit the arguments on the child.
  3523. $item['_load_functions'][$k] = $parent['_load_functions'][$k];
  3524. }
  3525. }
  3526. }
  3527. }
  3528. }
  3529. }
  3530. if (!isset($item['access callback']) && isset($item['access arguments'])) {
  3531. // Default callback.
  3532. $item['access callback'] = 'user_access';
  3533. }
  3534. if (!isset($item['access callback']) || empty($item['page callback'])) {
  3535. $item['access callback'] = 0;
  3536. }
  3537. if (is_bool($item['access callback'])) {
  3538. $item['access callback'] = intval($item['access callback']);
  3539. }
  3540. $item['load_functions'] = empty($item['_load_functions']) ? '' : serialize($item['_load_functions']);
  3541. $item += array(
  3542. 'access arguments' => array(),
  3543. 'access callback' => '',
  3544. 'page arguments' => array(),
  3545. 'page callback' => '',
  3546. 'delivery callback' => '',
  3547. 'title arguments' => array(),
  3548. 'title callback' => 't',
  3549. 'theme arguments' => array(),
  3550. 'theme callback' => '',
  3551. 'description' => '',
  3552. 'position' => '',
  3553. 'context' => 0,
  3554. 'tab_parent' => '',
  3555. 'tab_root' => $path,
  3556. 'path' => $path,
  3557. 'file' => '',
  3558. 'file path' => '',
  3559. 'include file' => '',
  3560. );
  3561. // Calculate out the file to be included for each callback, if any.
  3562. if ($item['file']) {
  3563. $file_path = $item['file path'] ? $item['file path'] : drupal_get_path('module', $item['module']);
  3564. $item['include file'] = $file_path . '/' . $item['file'];
  3565. }
  3566. }
  3567. // Sort the masks so they are in order of descending fit.
  3568. $masks = array_keys($masks);
  3569. rsort($masks);
  3570. return array($menu, $masks);
  3571. }
  3572. /**
  3573. * Saves data from menu_router_build() to the router table.
  3574. */
  3575. function _menu_router_save($menu, $masks) {
  3576. // Delete the existing router since we have some data to replace it.
  3577. db_truncate('menu_router')->execute();
  3578. // Prepare insert object.
  3579. $insert = db_insert('menu_router')
  3580. ->fields(array(
  3581. 'path',
  3582. 'load_functions',
  3583. 'to_arg_functions',
  3584. 'access_callback',
  3585. 'access_arguments',
  3586. 'page_callback',
  3587. 'page_arguments',
  3588. 'delivery_callback',
  3589. 'fit',
  3590. 'number_parts',
  3591. 'context',
  3592. 'tab_parent',
  3593. 'tab_root',
  3594. 'title',
  3595. 'title_callback',
  3596. 'title_arguments',
  3597. 'theme_callback',
  3598. 'theme_arguments',
  3599. 'type',
  3600. 'description',
  3601. 'position',
  3602. 'weight',
  3603. 'include_file',
  3604. ));
  3605. $num_records = 0;
  3606. foreach ($menu as $path => $item) {
  3607. // Fill in insert object values.
  3608. $insert->values(array(
  3609. 'path' => $item['path'],
  3610. 'load_functions' => $item['load_functions'],
  3611. 'to_arg_functions' => $item['to_arg_functions'],
  3612. 'access_callback' => $item['access callback'],
  3613. 'access_arguments' => serialize($item['access arguments']),
  3614. 'page_callback' => $item['page callback'],
  3615. 'page_arguments' => serialize($item['page arguments']),
  3616. 'delivery_callback' => $item['delivery callback'],
  3617. 'fit' => $item['_fit'],
  3618. 'number_parts' => $item['_number_parts'],
  3619. 'context' => $item['context'],
  3620. 'tab_parent' => $item['tab_parent'],
  3621. 'tab_root' => $item['tab_root'],
  3622. 'title' => $item['title'],
  3623. 'title_callback' => $item['title callback'],
  3624. 'title_arguments' => ($item['title arguments'] ? serialize($item['title arguments']) : ''),
  3625. 'theme_callback' => $item['theme callback'],
  3626. 'theme_arguments' => serialize($item['theme arguments']),
  3627. 'type' => $item['type'],
  3628. 'description' => $item['description'],
  3629. 'position' => $item['position'],
  3630. 'weight' => $item['weight'],
  3631. 'include_file' => $item['include file'],
  3632. ));
  3633. // Execute in batches to avoid the memory overhead of all of those records
  3634. // in the query object.
  3635. if (++$num_records == 20) {
  3636. $insert->execute();
  3637. $num_records = 0;
  3638. }
  3639. }
  3640. // Insert any remaining records.
  3641. $insert->execute();
  3642. // Store the masks.
  3643. variable_set('menu_masks', $masks);
  3644. return $menu;
  3645. }
  3646. /**
  3647. * Checks whether the site is in maintenance mode.
  3648. *
  3649. * This function will log the current user out and redirect to front page
  3650. * if the current user has no 'access site in maintenance mode' permission.
  3651. *
  3652. * @param $check_only
  3653. * If this is set to TRUE, the function will perform the access checks and
  3654. * return the site offline status, but not log the user out or display any
  3655. * messages.
  3656. *
  3657. * @return
  3658. * FALSE if the site is not in maintenance mode, the user login page is
  3659. * displayed, or the user has the 'access site in maintenance mode'
  3660. * permission. TRUE for anonymous users not being on the login page when the
  3661. * site is in maintenance mode.
  3662. */
  3663. function _menu_site_is_offline($check_only = FALSE) {
  3664. // Check if site is in maintenance mode.
  3665. if (variable_get('maintenance_mode', 0)) {
  3666. if (user_access('access site in maintenance mode')) {
  3667. // Ensure that the maintenance mode message is displayed only once
  3668. // (allowing for page redirects) and specifically suppress its display on
  3669. // the maintenance mode settings page.
  3670. if (!$check_only && $_GET['q'] != 'admin/config/development/maintenance') {
  3671. if (user_access('administer site configuration')) {
  3672. drupal_set_message(t('Operating in maintenance mode. <a href="@url">Go online.</a>', array('@url' => url('admin/config/development/maintenance'))), 'status', FALSE);
  3673. }
  3674. else {
  3675. drupal_set_message(t('Operating in maintenance mode.'), 'status', FALSE);
  3676. }
  3677. }
  3678. }
  3679. else {
  3680. return TRUE;
  3681. }
  3682. }
  3683. return FALSE;
  3684. }
  3685. /**
  3686. * @} End of "defgroup menu".
  3687. */