Merge branch '6.0/main-menu-callback'

bestpractical · Jan 13, 2025 · d13d0e0 · d13d0e0
2 parents ae78d9e + b9ae0bb
commit d13d0e0
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 4 deletions.
diff --git a/devel/docs/UPGRADING-6.0 b/devel/docs/UPGRADING-6.0
@@ -157,6 +157,21 @@ In addition to the above, the following callbacks changed or moved in RT 6.
 
 =over
 
+=item /Elements/Tabs Privileged and and SelfService
+
+These callbacks are used to modify RT's top menu and page menu, usually to
+add new things to the menus. The previous callbacks are still available,
+but RT no longer rebuilds the top navigation menu on every request. If you
+previously used one of these callbacks to modify the top navigation menu
+via C<Menu()>, that will no longer be defined or updated consistently in
+the existing callbacks.
+
+To add items to the main page menu, you can use two new callbacks added
+for this purpose:
+
+    /Elements/Header PrivilegedMainNav
+    /Elements/Header SelfServiceMainNav
+
 =item /Prefs/Other.html BeforeOption
 
 This callback is still in the same location on the rendered page, but it has

diff --git a/lib/RT/Interface/Web/MenuBuilder.pm b/lib/RT/Interface/Web/MenuBuilder.pm
@@ -62,7 +62,8 @@ sub QueryString { HTML::Mason::Commands::QueryString( @_ ); }
 sub ShortenSearchQuery { HTML::Mason::Commands::ShortenSearchQuery( @_ ); }
 
 sub BuildMainNav {
-    my $top = shift;
+    my $top  = shift;
+    my %args = @_;
 
     my $current_user = $HTML::Mason::Commands::session{CurrentUser};
 
@@ -347,6 +348,9 @@ sub BuildMainNav {
     if ( $current_user->Name ) {
         $about_me->child( logout => title => loc('Logout'), path => '/NoAuth/Logout.html' );
     }
+
+    # Added in RT6 to handle main menu changes
+    $HTML::Mason::Commands::m->callback( CallbackName => 'PrivilegedMainNav', ARGSRef => \%args, CallbackPage => '/Elements/Header' );
 }
 
 sub BuildPageNav {
@@ -1962,7 +1966,8 @@ sub _BuildAdminPageMenu {
 }
 
 sub BuildSelfServiceMainNav {
-    my $top          = shift;
+    my $top  = shift;
+    my %args = @_;
 
     my $current_user = $HTML::Mason::Commands::session{CurrentUser};
 
@@ -2023,6 +2028,8 @@ sub BuildSelfServiceMainNav {
         $about_me->child( logout => title => loc('Logout'), path => '/NoAuth/Logout.html' );
     }
 
+    # Added in RT6 to handle main menu changes
+    $HTML::Mason::Commands::m->callback( CallbackName => 'SelfServiceMainNav', ARGSRef => \%args, CallbackPage => '/Elements/Header' );
 }
 
 sub BuildSelfServicePageNav {

diff --git a/share/html/Elements/Header b/share/html/Elements/Header
@@ -205,10 +205,10 @@ if ( $session{CurrentUser} && $session{CurrentUser}->Id ) {
 
         require RT::Interface::Web::MenuBuilder;
         if ( $request_path =~ m{^/SelfService/} ) {
-            RT::Interface::Web::MenuBuilder::BuildSelfServiceMainNav( Menu() );
+            RT::Interface::Web::MenuBuilder::BuildSelfServiceMainNav( Menu(), %ARGS );
         }
         else {
-            RT::Interface::Web::MenuBuilder::BuildMainNav( Menu() );
+            RT::Interface::Web::MenuBuilder::BuildMainNav( Menu(), %ARGS );
         }
 
         my $app_overflow = Menu()->child( overflow => title => loc('More'), sort_order => 99999);