From dddfb2203f9e88cda64274f5ddda4c4b3eac2258 Mon Sep 17 00:00:00 2001 From: sunnavy Date: Fri, 8 Dec 2023 09:52:31 -0500 Subject: [PATCH] Support inline edit for assets --- etc/RT_Config.pm.in | 9 +++ share/html/Asset/Display.html | 46 ++++++++++- share/html/Asset/Elements/EditPeopleInline | 93 ++++++++++++++++++++++ share/html/Asset/Elements/ShowSummary | 61 ++++++++++++-- share/html/Asset/Search/Bulk.html | 1 + share/html/Elements/CollectionAsTable/Row | 13 ++- share/html/Elements/CollectionList | 2 +- share/html/Elements/ColumnMap | 26 +++++- share/html/Elements/RT__Asset/ColumnMap | 6 +- share/html/Helpers/AssetUpdate | 79 ++++++++++++++++++ share/html/Helpers/CollectionListRow | 2 +- t/web/helpers-http-cache-headers.t | 20 ++++- 12 files changed, 343 insertions(+), 15 deletions(-) create mode 100644 share/html/Asset/Elements/EditPeopleInline create mode 100644 share/html/Helpers/AssetUpdate diff --git a/etc/RT_Config.pm.in b/etc/RT_Config.pm.in index 31e31631686..fe528c51e7e 100644 --- a/etc/RT_Config.pm.in +++ b/etc/RT_Config.pm.in @@ -2593,6 +2593,15 @@ Grouping" are created by the L setting. 'Links' => 'hide', 'People' => 'link', }, + 'RT::Asset' => { + '_default' => 'click', + + 'Grouping Name' => 'link', + 'Another Grouping' => 'click', + 'Dates' => 'hide', + 'Links' => 'hide', + 'People' => 'link', + }, ); =back diff --git a/share/html/Asset/Display.html b/share/html/Asset/Display.html index 553fb4f66a4..b1035b45fef 100644 --- a/share/html/Asset/Display.html +++ b/share/html/Asset/Display.html @@ -53,7 +53,7 @@ <& /Elements/ListActions, actions => \@results &> -<& Elements/ShowSummary, AssetObj => $asset &> +<& Elements/ShowSummary, AssetObj => $asset, InlineEdit => $InlineEdit &> % $m->callback(CallbackName => 'AfterShowSummary', ARGSRef => \%ARGS, Asset => $asset); @@ -68,9 +68,53 @@ <%args> $id => undef +$InlineEdit => RT->Config->Get( 'InlineEdit', $session{CurrentUser} ) <%init> my @results; my $asset = LoadAsset($id); + +# fill ACL cache +$asset->CurrentUser->PrincipalObj->HasRights( Object => $asset ); + +my $SkipProcessing; + +$m->callback( CallbackName => 'BeforeProcessArguments', + AssetObj => $asset, + ActionsRef => \@results, ARGSRef => \%ARGS, + SkipProcessing => \$SkipProcessing ); + +my ($status, @msg) = $m->comp( + '/Elements/ValidateCustomFields', + Object => $asset, + CustomFields => $asset->CustomFields, + ARGSRef => \%ARGS, +); +unless ($status) { + push @results, @msg; + $SkipProcessing = 1; +} + +if ( !$SkipProcessing ) { + + push @results, ProcessAssetRoleMembers( $asset => %ARGS ); + push @results, ProcessRecordLinks( RecordObj => $asset, ARGSRef => \%ARGS ); + push @results, ProcessObjectCustomFieldUpdates( Object => $asset, ARGSRef => \%ARGS ); + + push @results, UpdateRecordObject( + Object => $asset, + AttributesRef => [ $asset->WritableAttributes ], + ARGSRef => \%ARGS, + ); + +} + $m->callback(CallbackName => 'BeforeDisplay', ARGSRef => \%ARGS, Asset => $asset, Results => \@results); + +MaybeRedirectForResults( + Actions => \@results, + Path => '/Asset/Display.html', + Anchor => $ARGS{'Anchor'}, + Arguments => { id => $asset->Id }, +); diff --git a/share/html/Asset/Elements/EditPeopleInline b/share/html/Asset/Elements/EditPeopleInline new file mode 100644 index 00000000000..b0a3fbaf6f4 --- /dev/null +++ b/share/html/Asset/Elements/EditPeopleInline @@ -0,0 +1,93 @@ +%# BEGIN BPS TAGGED BLOCK {{{ +%# +%# COPYRIGHT: +%# +%# This software is Copyright (c) 1996-2023 Best Practical Solutions, LLC +%# +%# +%# (Except where explicitly superseded by other copyright notices) +%# +%# +%# LICENSE: +%# +%# This work is made available to you under the terms of Version 2 of +%# the GNU General Public License. A copy of that license should have +%# been provided with this software, but in any event can be snarfed +%# from www.gnu.org. +%# +%# This work is distributed in the hope that it will be useful, but +%# WITHOUT ANY WARRANTY; without even the implied warranty of +%# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +%# General Public License for more details. +%# +%# You should have received a copy of the GNU General Public License +%# along with this program; if not, write to the Free Software +%# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA +%# 02110-1301 or visit their web page on the internet at +%# http://www.gnu.org/licenses/old-licenses/gpl-2.0.html. +%# +%# +%# CONTRIBUTION SUBMISSION POLICY: +%# +%# (The following paragraph is not intended to limit the rights granted +%# to you to modify and distribute this software under the terms of +%# the GNU General Public License and is only of importance to you if +%# you choose to contribute your changes and enhancements to the +%# community by submitting them to Best Practical Solutions, LLC.) +%# +%# By intentionally submitting any modifications, corrections or +%# derivatives to this work, or any other work intended for use with +%# Request Tracker, to Best Practical Solutions, LLC, you confirm that +%# you are the copyright holder for those contributions and you grant +%# Best Practical Solutions, LLC a nonexclusive, worldwide, irrevocable, +%# royalty-free, perpetual, license to use, copy, create derivative +%# works based on those contributions, and sublicense and distribute +%# those contributions and any derivatives thereof. +%# +%# END BPS TAGGED BLOCK }}} + +% for my $role ($AssetObj->Roles( ACLOnly => 0 )) { +
+
<% $AssetObj->LabelForRole($role) %>
+ <& EditRoleMembers, Object => $AssetObj, Role => $role &> +
+% } + +
+
<&|/l&>Add a person
+
+
+ <& SelectRoleType, Object => $AssetObj, Name => "AddUserRoleMember-Role" &> +
+
+ " + class="form-control" + > +
+
+
+ +
+
<&|/l&>Add a group
+
+
+ <& SelectRoleType, Object => $AssetObj, Name => "AddGroupRoleMember-Role" &> +
+
+ " + class="form-control" + > +
+
+
+ +<& /Elements/EditCustomFields, Object => $AssetObj, Grouping => 'People', InTable => 1 &> +<%ARGS> +$AssetObj => undef + diff --git a/share/html/Asset/Elements/ShowSummary b/share/html/Asset/Elements/ShowSummary index 3aa12a3b22f..9ee3de3cdf5 100644 --- a/share/html/Asset/Elements/ShowSummary +++ b/share/html/Asset/Elements/ShowSummary @@ -47,6 +47,7 @@ %# END BPS TAGGED BLOCK }}} <%args> $AssetObj +$InlineEdit => 0 <%init> my @sections = ( @@ -56,9 +57,6 @@ my @sections = ( "Links", #loc ); -my $can_edit = $session{CurrentUser}->Privileged - && $AssetObj->CurrentUserHasRight("ModifyAsset"); - my %link; for my $section (@sections) { my $page = $section eq 'Basics' ? "Modify.html" : "Modify$section.html"; @@ -67,20 +65,71 @@ for my $section (@sections) { . "/Asset/$page?id=" . $AssetObj->id; } + +my $can_modify = $AssetObj->CurrentUserHasRight('ModifyAsset'); +my $can_modify_cf = $AssetObj->CurrentUserHasRight('ModifyCustomField'); + +$m->callback( CallbackName => 'ModifyRights', %ARGS, AssetObj => $AssetObj, ARGSRef => \%ARGS, + CanModify => \$can_modify, CanModifyCF => \$can_modify_cf ); + +my $edit_label = $m->interp->apply_escapes( loc("Edit"), 'h' ); +my $cancel_label = $m->interp->apply_escapes( loc("Cancel"), 'h' ); + +my %inline_edit_behavior; +if (RT->Config->Get('InlineEditPanelBehavior')) { + %inline_edit_behavior = %{ RT->Config->Get('InlineEditPanelBehavior')->{'RT::Asset'} || {} }; +} + +my $modify_inline + = '' + . qq{} + . '' + . '';
% for my $section (@sections) { +% my $modify_url = sprintf( $modify_inline, $m->interp->apply_escapes( $link{$section}, 'h' ) ); +% my $modify_behavior = $InlineEdit ? ($inline_edit_behavior{$section} || $inline_edit_behavior{_default} || 'link') : 'hide'; +
- <&| /Widgets/TitleBox, title => loc($section), title_href => $can_edit ? $link{$section} : "", title_class => "inverse", class => "asset-\L$section" &> - <& "Show$section", AssetObj => $AssetObj &> + <&| /Widgets/TitleBox, title => loc($section), title_href => ($can_modify || $can_modify_cf) ? $link{$section} : "", title_class => "inverse", + (($can_modify || $can_modify_cf) && $modify_behavior =~ /^(link|click)$/ ? (titleright_raw => $modify_url) : ()), + class => (join " ", "asset-\L$section", ($modify_behavior eq 'always' ? 'editing' : ())), + data => { 'inline-edit-behavior' => $modify_behavior } + &> +% unless ($modify_behavior eq 'always') { +
+ <& "Show$section", AssetObj => $AssetObj &> +
+% } +% if ($modify_behavior ne 'hide') { +
+ +% if ( $section eq 'Links' ) { + <& /Elements/EditLinks, Object => $AssetObj &> + <& /Elements/EditCustomFields, Object => $AssetObj, Grouping => $section, InTable => 1 &> +% } elsif ( $section eq 'People' ) { + <& /Asset/Elements/EditPeopleInline, AssetObj => $AssetObj &> +% } else { + <& "/Asset/Elements/Edit$section", AssetObj => $AssetObj &> +% } +
+
+ +
+
+
+% }
% } <& /Elements/ShowCustomFieldCustomGroupings, Object => $AssetObj, - title_href => $can_edit ? RT->Config->Get("WebPath") . "/Asset/ModifyCFs.html" : "", + title_href => ($can_modify || $can_modify_cf) ? RT->Config->Get("WebPath") . "/Asset/ModifyCFs.html" : "", TitleBoxARGS => { title_class => "inverse" }, GroupingClass => 'col-4' &> diff --git a/share/html/Asset/Search/Bulk.html b/share/html/Asset/Search/Bulk.html index 1f7e94d9ed6..41ade9d9f8d 100644 --- a/share/html/Asset/Search/Bulk.html +++ b/share/html/Asset/Search/Bulk.html @@ -62,6 +62,7 @@ Collection => $assets, AllowSorting => 1, DisplayFormat => $DisplayFormat, + InlineEdit => 0, &> % if (not $assets->Count) { <&|/l&>No assets matching search criteria found. diff --git a/share/html/Elements/CollectionAsTable/Row b/share/html/Elements/CollectionAsTable/Row index d8265e1d9d4..5cd3e8ecbc3 100644 --- a/share/html/Elements/CollectionAsTable/Row +++ b/share/html/Elements/CollectionAsTable/Row @@ -92,9 +92,15 @@ foreach my $column (@Format) { my %attrs; my @possible_attrs = qw(style align); - if ($InlineEdit && $record->isa('RT::Ticket') && $record->CurrentUserHasRight('ModifyTicket')) { - push(@possible_attrs, 'edit'); + if ( + $InlineEdit + && ( $record->isa('RT::Ticket') && $record->CurrentUserHasRight('ModifyTicket') + || $record->isa('RT::Asset') && $record->CurrentUserHasRight('ModifyAsset') ) + ) + { + push( @possible_attrs, 'edit' ); } + foreach my $attr (@possible_attrs) { if ( defined $column->{ $attr } ) { $attrs{ $attr } = $column->{ $attr }; @@ -171,7 +177,8 @@ foreach my $column (@Format) { $m->out('>'); if ( $attrs{edit} ) { - $m->out( '
' ); + my $helper_name = $record->isa('RT::Ticket') ? 'TicketUpdate' : 'AssetUpdate'; + $m->out( '' ); $m->out( $attrs{edit} ); $m->out( '' ); $m->out( '' ); diff --git a/share/html/Elements/CollectionList b/share/html/Elements/CollectionList index 2f6aeceeb9f..273931177f4 100644 --- a/share/html/Elements/CollectionList +++ b/share/html/Elements/CollectionList @@ -125,7 +125,7 @@ foreach my $col (@Format) { $Class ||= $Collection->ColumnMapClassName; -$InlineEdit = 0 unless $Collection->isa('RT::Tickets'); +$InlineEdit = 0 unless $Collection->isa('RT::Tickets') || $Collection->isa('RT::Assets'); $m->out('
'); $m->out('{load}->(@_); return unless $role->Id; if ($role->SingleValue) { - return \($m->scomp("/Elements/SingleUserRoleInput", role => $role, Ticket => $_[0])); + if ( $_[0]->isa('RT::Ticket') ) { + return \($m->scomp("/Elements/SingleUserRoleInput", role => $role, Ticket => $_[0])); + } + elsif ( $_[0]->isa('RT::Asset') ) { + my $group = $_[0]->RoleGroup( $role->GroupType); + my $user = $group->UserMembersObj()->First || RT->Nobody; + my $user_name = $m->interp->apply_escapes( $user->Name, 'h' ); + my $group_type = $role->GroupType; + return \qq{}; + } + else { + RT->Logger->warning( "Invalid object for custom roles: " . ref $_[0] ); + return undef; + } } else { return undef; @@ -447,6 +460,17 @@ if ($RecordClass->DOES("RT::Record::Role::Roles")) { } }, value => sub { return $role_value->($role, @_, @_ == 2 ? '' : () ) }, + edit => sub { + if ($attrs->{Single} && $RecordClass eq 'RT::Asset' ) { + my $group = $_[0]->RoleGroup($role); + my $user = $group->UserMembersObj()->First || RT->Nobody; + my $user_name = $m->interp->apply_escapes( $user->Name, 'h' ); + return \qq{}; + } + else { + return undef; + } + }, }; $ROLE_MAP->{$RecordClass}{$role . "s"} = $ROLE_MAP->{$RecordClass}{$role} diff --git a/share/html/Elements/RT__Asset/ColumnMap b/share/html/Elements/RT__Asset/ColumnMap index 578ef038ec8..9934d27dd32 100644 --- a/share/html/Elements/RT__Asset/ColumnMap +++ b/share/html/Elements/RT__Asset/ColumnMap @@ -77,21 +77,25 @@ my $COLUMN_MAP = { attribute => 'Name', title => 'Name', value => sub { $_[0]->Name }, + edit => sub { return \('') }, }, Description => { attribute => 'Description', title => 'Description', value => sub { $_[0]->Description }, + edit => sub { return \('') }, }, Catalog => { attribute => 'Catalog', title => 'Catalog', # loc value => sub { $_[0]->CatalogObj->Name }, + edit => sub { return \($m->scomp('/Asset/Elements/SelectCatalog', Default => $_[0]->Catalog, Name => 'Catalog', ShowNullOption => 0)) }, }, Status => { title => 'Status', attribute => 'Status', - value => sub { loc($_[0]->Status) } + value => sub { loc($_[0]->Status) }, + edit => sub { return \($m->scomp("/Asset/Elements/SelectStatus", AssetObj => $_[0], Name => 'Status' ) ) }, }, ActiveTickets => { title => 'Active tickets', # loc diff --git a/share/html/Helpers/AssetUpdate b/share/html/Helpers/AssetUpdate new file mode 100644 index 00000000000..b95e163c48f --- /dev/null +++ b/share/html/Helpers/AssetUpdate @@ -0,0 +1,79 @@ +%# BEGIN BPS TAGGED BLOCK {{{ +%# +%# COPYRIGHT: +%# +%# This software is Copyright (c) 1996-2023 Best Practical Solutions, LLC +%# +%# +%# (Except where explicitly superseded by other copyright notices) +%# +%# +%# LICENSE: +%# +%# This work is made available to you under the terms of Version 2 of +%# the GNU General Public License. A copy of that license should have +%# been provided with this software, but in any event can be snarfed +%# from www.gnu.org. +%# +%# This work is distributed in the hope that it will be useful, but +%# WITHOUT ANY WARRANTY; without even the implied warranty of +%# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +%# General Public License for more details. +%# +%# You should have received a copy of the GNU General Public License +%# along with this program; if not, write to the Free Software +%# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA +%# 02110-1301 or visit their web page on the internet at +%# http://www.gnu.org/licenses/old-licenses/gpl-2.0.html. +%# +%# +%# CONTRIBUTION SUBMISSION POLICY: +%# +%# (The following paragraph is not intended to limit the rights granted +%# to you to modify and distribute this software under the terms of +%# the GNU General Public License and is only of importance to you if +%# you choose to contribute your changes and enhancements to the +%# community by submitting them to Best Practical Solutions, LLC.) +%# +%# By intentionally submitting any modifications, corrections or +%# derivatives to this work, or any other work intended for use with +%# Request Tracker, to Best Practical Solutions, LLC, you confirm that +%# you are the copyright holder for those contributions and you grant +%# Best Practical Solutions, LLC a nonexclusive, worldwide, irrevocable, +%# royalty-free, perpetual, license to use, copy, create derivative +%# works based on those contributions, and sublicense and distribute +%# those contributions and any derivatives thereof. +%# +%# END BPS TAGGED BLOCK }}} +% $r->content_type('application/json; charset=utf-8'); +<% JSON( { actions => \@results } ) |n %> +% $m->abort; + +<%ARGS> +$id + + +<%INIT> +my @results; + +my $asset = LoadAsset($id); + +# fill ACL cache +$asset->CurrentUser->PrincipalObj->HasRights( Object => $asset ); + +$m->callback(CallbackName => 'ProcessArguments', + Asset => $asset, + ARGSRef => \%ARGS, + results => \@results); + +push @results, ProcessAssetRoleMembers( $asset => %ARGS ); +push @results, ProcessRecordLinks( RecordObj => $asset, ARGSRef => \%ARGS ); +push @results, ProcessObjectCustomFieldUpdates( Object => $asset, ARGSRef => \%ARGS ); + +push @results, UpdateRecordObject( + Object => $asset, + AttributesRef => [ $asset->WritableAttributes ], + ARGSRef => \%ARGS +); + + diff --git a/share/html/Helpers/CollectionListRow b/share/html/Helpers/CollectionListRow index a993f767d8e..6d1cdc2905a 100644 --- a/share/html/Helpers/CollectionListRow +++ b/share/html/Helpers/CollectionListRow @@ -60,7 +60,7 @@ $Warning => undef $DisplayFormat = $m->comp('/Elements/ScrubHTML', Content => $DisplayFormat); my @Format = $m->comp('/Elements/CollectionAsTable/ParseFormat', Format => $DisplayFormat); -$m->abort unless ( $ObjectClass // '' ) eq 'RT::Ticket'; +$m->abort unless ( $ObjectClass // '' ) =~ /^RT::(?:Ticket|Asset)$/; my $record = $ObjectClass->new($session{CurrentUser}); $record->Load($ObjectId); diff --git a/t/web/helpers-http-cache-headers.t b/t/web/helpers-http-cache-headers.t index 2e661a231b7..1f03859a8f3 100644 --- a/t/web/helpers-http-cache-headers.t +++ b/t/web/helpers-http-cache-headers.t @@ -57,6 +57,19 @@ diag "create a ticket via the API"; $ticket_id = $id; } +my $asset_id; +# Create an asset so requests to /Helpers/AssetUpdate can succeed. +diag "create an asset via the API"; +{ + my $asset = RT::Asset->new( RT->SystemUser ); + my ($id, $txn, $msg) = $asset->Create( + Catalog => 'General assets', + Name => 'test asset', + ); + ok $id, 'created a asset #'. $id or diag "error: $msg"; + is $asset->Name, 'test asset', 'correct name'; + $asset_id = $id; +} my $expected; diag "set up expected date headers"; @@ -81,7 +94,12 @@ diag "set up expected date headers"; } foreach my $endpoint ( @endpoints ) { - $m->get_ok( $endpoint . "?id=${ticket_id}&Status=open&Requestor=root" ); + if ( $endpoint =~ m{/Helpers/AssetUpdate} ) { + $m->get_ok( $endpoint . "?id=${asset_id}&Status=allocated" ); + } + else { + $m->get_ok( $endpoint . "?id=${ticket_id}&Status=open&Requestor=root" ); + } my $header_key = 'default'; if ( $endpoint =~ m|Autocomplete| ) {