Add EndOfWidget callbacks for ticket display widgets

This allows extensions to insert content within the titlebox. One of our existing extensions needed this to add content to Times, at a location similar to the previous "EndOfList" from ShowBasics. Also pass the ticket object to other existing callbacks.
bestpractical · Jan 8, 2025 · 4e2118a · 4e2118a
1 parent 13f11d5
commit 4e2118a
Show file tree

Hide file tree

Showing 17 changed files with 39 additions and 29 deletions.
diff --git a/share/html/Elements/ShowCustomFieldCustomGroupings b/share/html/Elements/ShowCustomFieldCustomGroupings
@@ -111,6 +111,7 @@ for my $group ( @Groupings ) {
     </div>
   </form>
 % }
+% $m->callback( %ARGS, CallbackName => 'EndOfWidget', Object => $Object, Grouping => $group );
 </&>
 </div>
 % }

diff --git a/share/html/Ticket/Display.html b/share/html/Ticket/Display.html
@@ -62,6 +62,8 @@
 
 <& /Elements/ShowWidgets, InRow => 0, Object => $TicketObj, Page => 'Display' &>
 
+% $m->callback(CallbackName => 'EndOfPage', %ARGS, Ticket => $TicketObj);
+
 <%ARGS>
 $TicketObj => undef
 $ShowHeaders => 0

diff --git a/share/html/Ticket/Elements/ShowLinkedQueues b/share/html/Ticket/Elements/ShowLinkedQueues
@@ -154,7 +154,7 @@ $m->callback( CallbackName => 'MassageSearchArgs',
     <div class="empty-message"><% $empty_message %></div>
 % }
 % }
-
+% $m->callback( %ARGS, CallbackName => 'EndOfWidget', TicketObj => $TicketObj );
 </&>
 %   }
 %}

diff --git a/share/html/Ticket/Widgets/Display/Articles b/share/html/Ticket/Widgets/Display/Articles
@@ -45,9 +45,9 @@
 %# those contributions and any derivatives thereof.
 %#
 %# END BPS TAGGED BLOCK }}}
-% $m->callback( %ARGS, CallbackName => 'BeforeWidget' );
+% $m->callback( %ARGS, CallbackName => 'BeforeWidget', TicketObj => $Ticket );
 <& /Elements/ShowArticle, Ticket => $Ticket &>
-% $m->callback( %ARGS, CallbackName => 'AfterWidget' );
+% $m->callback( %ARGS, CallbackName => 'AfterWidget', TicketObj => $Ticket );
 
 <%ARGS>
 $Ticket

diff --git a/share/html/Ticket/Widgets/Display/Assets b/share/html/Ticket/Widgets/Display/Assets
@@ -45,11 +45,11 @@
 %# those contributions and any derivatives thereof.
 %#
 %# END BPS TAGGED BLOCK }}}
-% $m->callback( %ARGS, CallbackName => 'BeforeWidget' );
+% $m->callback( %ARGS, CallbackName => 'BeforeWidget', TicketObj => $Ticket );
 <div hx-trigger="ticketAssetsChanged from:body" hx-get="<% RT->Config->Get('WebPath') %>/Views/Ticket/ShowAssets?HTMXLoad=0&id=<% $Ticket->id %>">
   <& /Ticket/Elements/ShowAssets, Ticket => $Ticket &>
 </div>
-% $m->callback( %ARGS, CallbackName => 'AfterWidget' );
+% $m->callback( %ARGS, CallbackName => 'AfterWidget', TicketObj => $Ticket );
 
 <%ARGS>
 $Ticket

diff --git a/share/html/Ticket/Widgets/Display/Attachments b/share/html/Ticket/Widgets/Display/Attachments
@@ -45,9 +45,9 @@
 %# those contributions and any derivatives thereof.
 %#
 %# END BPS TAGGED BLOCK }}}
-% $m->callback( %ARGS, CallbackName => 'BeforeWidget' );
+% $m->callback( %ARGS, CallbackName => 'BeforeWidget', TicketObj => $Ticket );
 <& /Ticket/Elements/ShowAttachments, Ticket => $Ticket, Attachments => $ARGS{Attachments}, Count => RT->Config->Get('AttachmentListCount') &>
-% $m->callback( %ARGS, CallbackName => 'AfterWidget' );
+% $m->callback( %ARGS, CallbackName => 'AfterWidget', TicketObj => $Ticket );
 
 <%ARGS>
 $Ticket

diff --git a/share/html/Ticket/Widgets/Display/Basics b/share/html/Ticket/Widgets/Display/Basics
@@ -45,7 +45,7 @@
 %# those contributions and any derivatives thereof.
 %#
 %# END BPS TAGGED BLOCK }}}
-% $m->callback( %ARGS, CallbackName => 'BeforeWidget' );
+% $m->callback( %ARGS, CallbackName => 'BeforeWidget', TicketObj => $Ticket );
 
 <&| /Widgets/TitleBox, title => loc('The Basics'),
     (($can_modify || $can_modify_cf) ? (title_href => RT->Config->Get('WebPath')."/Ticket/Modify.html?id=".$Ticket->Id) : ()),
@@ -72,8 +72,9 @@
     </div>
   </form>
 % }
+% $m->callback( %ARGS, CallbackName => 'EndOfWidget', TicketObj => $Ticket );
 </&>
-% $m->callback( %ARGS, CallbackName => 'AfterWidget' );
+% $m->callback( %ARGS, CallbackName => 'AfterWidget', TicketObj => $Ticket );
 
 <%INIT>
 my %inline_edit_behavior;

diff --git a/share/html/Ticket/Widgets/Display/CustomFieldCustomGroupings b/share/html/Ticket/Widgets/Display/CustomFieldCustomGroupings
@@ -45,7 +45,7 @@
 %# those contributions and any derivatives thereof.
 %#
 %# END BPS TAGGED BLOCK }}}
-% $m->callback( %ARGS, CallbackName => 'BeforeWidget' );
+% $m->callback( %ARGS, CallbackName => 'BeforeWidget', TicketObj => $Ticket );
 
 <& /Elements/ShowCustomFieldCustomGroupings,
     Object       => $Ticket,
@@ -54,7 +54,7 @@
     $ARGS{Argument} ? ( Groupings => [ map { $_ eq 'Default' ? '' : $_ } split /\s*,\s*/, $ARGS{Argument} ] ) : (),
 &>
 
-% $m->callback( %ARGS, CallbackName => 'AfterWidget' );
+% $m->callback( %ARGS, CallbackName => 'AfterWidget', TicketObj => $Ticket );
 
 <%INIT>
 my $can_modify = $Ticket->CurrentUserHasRight('ModifyTicket');

diff --git a/share/html/Ticket/Widgets/Display/Dates b/share/html/Ticket/Widgets/Display/Dates
@@ -45,7 +45,7 @@
 %# those contributions and any derivatives thereof.
 %#
 %# END BPS TAGGED BLOCK }}}
-% $m->callback( %ARGS, CallbackName => 'BeforeWidget' );
+% $m->callback( %ARGS, CallbackName => 'BeforeWidget', TicketObj => $Ticket );
 
 <&| /Widgets/TitleBox, title => loc("Dates"),
     ($can_modify ? (title_href => RT->Config->Get('WebPath')."/Ticket/ModifyDates.html?id=".$Ticket->Id) : ()),
@@ -71,8 +71,9 @@
     </div>
   </form>
 % }
+% $m->callback( %ARGS, CallbackName => 'EndOfWidget', TicketObj => $Ticket );
 </&>
-% $m->callback( %ARGS, CallbackName => 'AfterWidget' );
+% $m->callback( %ARGS, CallbackName => 'AfterWidget', TicketObj => $Ticket );
 
 <%INIT>
 my %inline_edit_behavior;

diff --git a/share/html/Ticket/Widgets/Display/Description b/share/html/Ticket/Widgets/Display/Description
@@ -45,7 +45,7 @@
 %# those contributions and any derivatives thereof.
 %#
 %# END BPS TAGGED BLOCK }}}
-% $m->callback( %ARGS, CallbackName => 'BeforeWidget' );
+% $m->callback( %ARGS, CallbackName => 'BeforeWidget', TicketObj => $Ticket );
 
 <&| /Widgets/TitleBox, title => loc('Description'),
     (($can_modify || $can_modify_cf) && $modify_behavior =~ /^(link|click)$/ ? (titleright_raw => $m->scomp('/Elements/InlineEditLink')) : ()),
@@ -71,8 +71,9 @@
     </div>
   </form>
 % }
+% $m->callback( %ARGS, CallbackName => 'EndOfWidget', TicketObj => $Ticket );
 </&>
-% $m->callback( %ARGS, CallbackName => 'AfterWidget' );
+% $m->callback( %ARGS, CallbackName => 'AfterWidget', TicketObj => $Ticket );
 
 <%INIT>
 my %inline_edit_behavior;

diff --git a/share/html/Ticket/Widgets/Display/History b/share/html/Ticket/Widgets/Display/History
@@ -46,7 +46,7 @@
 %#
 %# END BPS TAGGED BLOCK }}}
 % $m->callback( %ARGS, %$DECODED_ARGS, Ticket => $Ticket, CallbackName => 'BeforeShowHistory', CallbackPage => '/Ticket/Display.html' );
-% $m->callback( %ARGS, CallbackName => 'BeforeWidget' );
+% $m->callback( %ARGS, CallbackName => 'BeforeWidget', TicketObj => $Ticket );
 
 % my $ShowHistory = RT->Config->Get("ShowHistory", $session{'CurrentUser'});
 % if ($ShowHistory eq "scroll") {
@@ -71,7 +71,7 @@
     &>
 % }
 
-% $m->callback( %ARGS, CallbackName => 'AfterWidget' );
+% $m->callback( %ARGS, CallbackName => 'AfterWidget', TicketObj => $Ticket );
 
 <%ARGS>
 $Ticket

diff --git a/share/html/Ticket/Widgets/Display/LinkedQueues b/share/html/Ticket/Widgets/Display/LinkedQueues
@@ -45,11 +45,11 @@
 %# those contributions and any derivatives thereof.
 %#
 %# END BPS TAGGED BLOCK }}}
-% $m->callback( %ARGS, CallbackName => 'BeforeWidget' );
+% $m->callback( %ARGS, CallbackName => 'BeforeWidget', TicketObj => $Ticket );
 <& /Ticket/Elements/ShowLinkedQueues,
     TicketObj => $Ticket,
 &>
-% $m->callback( %ARGS, CallbackName => 'AfterWidget' );
+% $m->callback( %ARGS, CallbackName => 'AfterWidget', TicketObj => $Ticket );
 
 <%ARGS>
 $Ticket

diff --git a/share/html/Ticket/Widgets/Display/Links b/share/html/Ticket/Widgets/Display/Links
@@ -45,7 +45,7 @@
 %# those contributions and any derivatives thereof.
 %#
 %# END BPS TAGGED BLOCK }}}
-% $m->callback( %ARGS, CallbackName => 'BeforeWidget' );
+% $m->callback( %ARGS, CallbackName => 'BeforeWidget', TicketObj => $Ticket );
 
 % $m->callback( %ARGS, CallbackName => 'LinksExtra', extra => \@extra );
 <&| /Widgets/TitleBox, title => loc('Links'),
@@ -77,9 +77,10 @@
     </div>
   </form>
 % }
+% $m->callback( %ARGS, CallbackName => 'EndOfWidget', TicketObj => $Ticket );
 </&>
 
-% $m->callback( %ARGS, CallbackName => 'AfterWidget' );
+% $m->callback( %ARGS, CallbackName => 'AfterWidget', TicketObj => $Ticket );
 
 <%INIT>
 my %inline_edit_behavior;

diff --git a/share/html/Ticket/Widgets/Display/People b/share/html/Ticket/Widgets/Display/People
@@ -45,7 +45,7 @@
 %# those contributions and any derivatives thereof.
 %#
 %# END BPS TAGGED BLOCK }}}
-% $m->callback( %ARGS, CallbackName => 'BeforeWidget' );
+% $m->callback( %ARGS, CallbackName => 'BeforeWidget', TicketObj => $Ticket );
 
 <&| /Widgets/TitleBox, title => loc('People'),
     (($can_modify || $can_modify_owner || $can_modify_people) ? (title_href => RT->Config->Get('WebPath')."/Ticket/ModifyPeople.html?id=".$Ticket->Id) : ()),
@@ -71,9 +71,10 @@
     </div>
   </form>
 % }
+% $m->callback( %ARGS, CallbackName => 'EndOfWidget', TicketObj => $Ticket );
 </&>
 
-% $m->callback( %ARGS, CallbackName => 'AfterWidget' );
+% $m->callback( %ARGS, CallbackName => 'AfterWidget', TicketObj => $Ticket );
 
 <%INIT>
 my %inline_edit_behavior;

diff --git a/share/html/Ticket/Widgets/Display/Reminders b/share/html/Ticket/Widgets/Display/Reminders
@@ -45,7 +45,7 @@
 %# those contributions and any derivatives thereof.
 %#
 %# END BPS TAGGED BLOCK }}}
-% $m->callback( %ARGS, CallbackName => 'BeforeWidget' );
+% $m->callback( %ARGS, CallbackName => 'BeforeWidget', TicketObj => $Ticket );
 % if ( RT->Config->Get('EnableReminders') ) {
 <&|/Widgets/TitleBox, title => loc("Reminders"),
     title_href => RT->Config->Get('WebPath')."/Ticket/Reminders.html?id=".$Ticket->Id,
@@ -56,9 +56,10 @@
       <& /Ticket/Elements/Reminders, Ticket => $Ticket, ShowCompleted => 0 &>
     </div>
   </form>
+% $m->callback( %ARGS, CallbackName => 'EndOfWidget', TicketObj => $Ticket );
 </&>
 % }
-% $m->callback( %ARGS, CallbackName => 'AfterWidget' );
+% $m->callback( %ARGS, CallbackName => 'AfterWidget', TicketObj => $Ticket );
 <%ARGS>
 $Ticket
 </%ARGS>
diff --git a/share/html/Ticket/Widgets/Display/Requestors b/share/html/Ticket/Widgets/Display/Requestors
@@ -45,11 +45,11 @@
 %# those contributions and any derivatives thereof.
 %#
 %# END BPS TAGGED BLOCK }}}
-% $m->callback( %ARGS, CallbackName => 'BeforeWidget' );
+% $m->callback( %ARGS, CallbackName => 'BeforeWidget', TicketObj => $Ticket );
 <div hx-trigger="ticketRequestorChanged from:body" hx-get="<% RT->Config->Get('WebPath') %>/Views/Ticket/ShowRequestor?HTMXLoad=0&id=<% $Ticket->id %>">
   <& /Ticket/Elements/ShowRequestor, Ticket => $Ticket &>
 </div>
-% $m->callback( %ARGS, CallbackName => 'AfterWidget' );
+% $m->callback( %ARGS, CallbackName => 'AfterWidget', TicketObj => $Ticket );
 
 <%ARGS>
 $Ticket

diff --git a/share/html/Ticket/Widgets/Display/Times b/share/html/Ticket/Widgets/Display/Times
@@ -45,7 +45,7 @@
 %# those contributions and any derivatives thereof.
 %#
 %# END BPS TAGGED BLOCK }}}
-% $m->callback( %ARGS, CallbackName => 'BeforeWidget' );
+% $m->callback( %ARGS, CallbackName => 'BeforeWidget', TicketObj => $Ticket );
 
 % if ($show_time_worked) {
 <&| /Widgets/TitleBox, title => loc('Time'),
@@ -73,9 +73,10 @@
     </div>
   </form>
 % }
+% $m->callback( %ARGS, CallbackName => 'EndOfWidget', TicketObj => $Ticket );
 </&>
 % }  # End if $show_time_worked
-% $m->callback( %ARGS, CallbackName => 'AfterWidget' );
+% $m->callback( %ARGS, CallbackName => 'AfterWidget', TicketObj => $Ticket );
 
 <%init>
 my %inline_edit_behavior;
-Original file line number
+Diff line change
@@ Expand Up / @@ -111,6 +111,7 @@ for my $group ( @Groupings ) { @@
         </div>
       </form>
     % }
+    % $m->callback( %ARGS, CallbackName => 'EndOfWidget', Object => $Object, Grouping => $group );
     </&>
     </div>
     % }
@@ Expand Down @@