init III
This commit is contained in:
527
Perl OTRS/Kernel/Modules/AgentITSMChangeHistory.pm
Normal file
527
Perl OTRS/Kernel/Modules/AgentITSMChangeHistory.pm
Normal file
@@ -0,0 +1,527 @@
|
||||
# --
|
||||
# Copyright (C) 2001-2019 OTRS AG, https://otrs.com/
|
||||
# --
|
||||
# This software comes with ABSOLUTELY NO WARRANTY. For details, see
|
||||
# the enclosed file COPYING for license information (GPL). If you
|
||||
# did not receive this file, see https://www.gnu.org/licenses/gpl-3.0.txt.
|
||||
# --
|
||||
|
||||
package Kernel::Modules::AgentITSMChangeHistory;
|
||||
|
||||
use strict;
|
||||
use warnings;
|
||||
|
||||
use Kernel::Language qw(Translatable);
|
||||
|
||||
our $ObjectManagerDisabled = 1;
|
||||
|
||||
sub new {
|
||||
my ( $Type, %Param ) = @_;
|
||||
|
||||
# allocate new hash for object
|
||||
my $Self = {%Param};
|
||||
bless( $Self, $Type );
|
||||
|
||||
return $Self;
|
||||
}
|
||||
|
||||
sub Run {
|
||||
my ( $Self, %Param ) = @_;
|
||||
|
||||
# get needed change id
|
||||
my $ChangeID = $Kernel::OM->Get('Kernel::System::Web::Request')->GetParam( Param => 'ChangeID' );
|
||||
|
||||
# get layout object
|
||||
my $LayoutObject = $Kernel::OM->Get('Kernel::Output::HTML::Layout');
|
||||
|
||||
# check needed stuff
|
||||
if ( !$ChangeID ) {
|
||||
|
||||
# error page
|
||||
return $LayoutObject->ErrorScreen(
|
||||
Message => Translatable('Can\'t show history, as no ChangeID is given!'),
|
||||
Comment => Translatable('Please contact the administrator.'),
|
||||
);
|
||||
}
|
||||
|
||||
# get needed objects
|
||||
my $ConfigObject = $Kernel::OM->Get('Kernel::Config');
|
||||
my $ChangeObject = $Kernel::OM->Get('Kernel::System::ITSMChange');
|
||||
my $HistoryObject = $Kernel::OM->Get('Kernel::System::ITSMChange::History');
|
||||
|
||||
# get config of frontend module
|
||||
$Self->{Config} = $ConfigObject->Get("ITSMChange::Frontend::$Self->{Action}");
|
||||
|
||||
# check permissions
|
||||
my $Access = $ChangeObject->Permission(
|
||||
Type => $Self->{Config}->{Permission},
|
||||
Action => $Self->{Action},
|
||||
ChangeID => $ChangeID,
|
||||
UserID => $Self->{UserID},
|
||||
);
|
||||
|
||||
# error screen
|
||||
if ( !$Access ) {
|
||||
return $LayoutObject->NoPermission(
|
||||
Message =>
|
||||
$LayoutObject->{LanguageObject}->Translate( 'You need %s permissions!', $Self->{Config}->{Permission} ),
|
||||
WithHeader => 'yes',
|
||||
);
|
||||
}
|
||||
|
||||
# get change information
|
||||
my $Change = $ChangeObject->ChangeGet(
|
||||
ChangeID => $ChangeID,
|
||||
UserID => $Self->{UserID},
|
||||
);
|
||||
|
||||
# check error
|
||||
if ( !$Change ) {
|
||||
return $LayoutObject->ErrorScreen(
|
||||
Message =>
|
||||
$LayoutObject->{LanguageObject}->Translate( 'Change "%s" not found in the database!', $ChangeID ),
|
||||
Comment => Translatable('Please contact the administrator.'),
|
||||
);
|
||||
}
|
||||
|
||||
# build a lookup hash with all workorder IDs of this change
|
||||
my %WorkOrderIDLookup = map { $_ => 1 } @{ $Change->{WorkOrderIDs} };
|
||||
|
||||
# get history entries
|
||||
my $HistoryEntriesRef = $HistoryObject->ChangeHistoryGet(
|
||||
ChangeID => $ChangeID,
|
||||
UserID => $Self->{UserID},
|
||||
) || [];
|
||||
|
||||
# get order direction
|
||||
my @HistoryLines = @{$HistoryEntriesRef};
|
||||
if ( $ConfigObject->Get('ITSMChange::Frontend::HistoryOrder') eq 'reverse' ) {
|
||||
@HistoryLines = reverse @{$HistoryEntriesRef};
|
||||
}
|
||||
|
||||
# make some lookups in advance to improve performance
|
||||
my $Cache = {};
|
||||
|
||||
# get condition object
|
||||
my $ConditionObject = $Kernel::OM->Get('Kernel::System::ITSMChange::ITSMCondition');
|
||||
|
||||
# get the object list
|
||||
$Cache->{ObjectList} = $ConditionObject->ObjectList(
|
||||
UserID => $Self->{UserID},
|
||||
);
|
||||
|
||||
# get the attribute list
|
||||
$Cache->{AttributeList} = $ConditionObject->AttributeList(
|
||||
UserID => $Self->{UserID},
|
||||
);
|
||||
|
||||
# get the operator list
|
||||
$Cache->{OperatorList} = $ConditionObject->OperatorList(
|
||||
UserID => $Self->{UserID},
|
||||
);
|
||||
|
||||
# max length of strings
|
||||
my $MaxLength = 30;
|
||||
|
||||
# Get translatable history strings.
|
||||
my %HistoryStrings = $HistoryObject->HistoryStringsList();
|
||||
|
||||
# create table
|
||||
my $Counter = 1;
|
||||
HISTORYENTRY:
|
||||
for my $HistoryEntry (@HistoryLines) {
|
||||
$Counter++;
|
||||
|
||||
# set fieldname to empty string if there is no fieldname
|
||||
$HistoryEntry->{Fieldname} ||= '';
|
||||
|
||||
# do not show internal entries from workorder number recalculation
|
||||
next HISTORYENTRY if $HistoryEntry->{Fieldname} eq 'NoNumberCalc';
|
||||
|
||||
# data for a single row, will be passed to the dtl
|
||||
my %Data = %{$HistoryEntry};
|
||||
|
||||
# determine what should be shown
|
||||
my $HistoryType = $HistoryEntry->{HistoryType};
|
||||
if (
|
||||
$HistoryType =~ m{
|
||||
\A
|
||||
(?: (?: Change | ChangeCAB | WorkOrder ) Update )
|
||||
| (?: (?: Condition | Expression | Action ) (?: Add | Update | Delete | DeleteAll | Execute ) )
|
||||
\z
|
||||
}xms
|
||||
)
|
||||
{
|
||||
|
||||
# The displayed fieldname might be changed in the following loop
|
||||
my $DisplayedFieldname = $HistoryEntry->{Fieldname};
|
||||
|
||||
# set default values for some keys
|
||||
for my $ContentNewOrOld (qw(ContentNew ContentOld)) {
|
||||
if ( !defined $HistoryEntry->{$ContentNewOrOld} ) {
|
||||
$HistoryEntry->{$ContentNewOrOld} = '';
|
||||
}
|
||||
else {
|
||||
|
||||
# get user object
|
||||
my $UserObject = $Kernel::OM->Get('Kernel::System::User');
|
||||
|
||||
# for the ID fields, we replace ID with its textual value
|
||||
if (
|
||||
my ($Type) = $HistoryEntry->{Fieldname} =~ m{
|
||||
\A # string start
|
||||
( # start capture of $Type
|
||||
Category | Impact | Priority
|
||||
| ChangeState
|
||||
| WorkOrderState | WorkOrderType
|
||||
| WorkOrderAgent | ChangeBuilder | ChangeManager
|
||||
| Valid
|
||||
| Object | Attribute | Operator
|
||||
) # end capture of $Type
|
||||
ID # processing only for the 'ID' fields
|
||||
}xms
|
||||
)
|
||||
{
|
||||
if ( $HistoryEntry->{$ContentNewOrOld} ) {
|
||||
my $Value;
|
||||
my $TranslationNeeded = 1;
|
||||
|
||||
# get work order object
|
||||
my $WorkOrderObject = $Kernel::OM->Get('Kernel::System::ITSMChange::ITSMWorkOrder');
|
||||
|
||||
if ( $Type eq 'WorkOrderState' ) {
|
||||
$Value = $WorkOrderObject->WorkOrderStateLookup(
|
||||
WorkOrderStateID => $HistoryEntry->{$ContentNewOrOld},
|
||||
);
|
||||
}
|
||||
elsif ( $Type eq 'WorkOrderType' ) {
|
||||
$Value = $WorkOrderObject->WorkOrderTypeLookup(
|
||||
WorkOrderTypeID => $HistoryEntry->{$ContentNewOrOld},
|
||||
);
|
||||
}
|
||||
elsif ( $Type eq 'ChangeState' ) {
|
||||
$Value = $ChangeObject->ChangeStateLookup(
|
||||
ChangeStateID => $HistoryEntry->{$ContentNewOrOld},
|
||||
);
|
||||
}
|
||||
elsif (
|
||||
$Type eq 'WorkOrderAgent'
|
||||
|| $Type eq 'ChangeBuilder'
|
||||
|| $Type eq 'ChangeManager'
|
||||
)
|
||||
{
|
||||
$Value = $UserObject->UserLookup(
|
||||
UserID => $HistoryEntry->{$ContentNewOrOld},
|
||||
);
|
||||
|
||||
# the login names are not to be translated
|
||||
$TranslationNeeded = 0;
|
||||
}
|
||||
elsif (
|
||||
$Type eq 'Category'
|
||||
|| $Type eq 'Impact'
|
||||
|| $Type eq 'Priority'
|
||||
)
|
||||
{
|
||||
$Value = $ChangeObject->ChangeCIPLookup(
|
||||
ID => $HistoryEntry->{$ContentNewOrOld},
|
||||
Type => $Type,
|
||||
);
|
||||
}
|
||||
elsif ( $Type eq 'Valid' ) {
|
||||
|
||||
# get the UpdateID (ConditionID or ExpressionID or ActionID)
|
||||
# and the AttributeID
|
||||
if ( $HistoryEntry->{$ContentNewOrOld} =~ m{ %% }xms ) {
|
||||
( $HistoryEntry->{UpdateID}, $HistoryEntry->{$ContentNewOrOld} ) = split m/%%/,
|
||||
$HistoryEntry->{$ContentNewOrOld};
|
||||
}
|
||||
|
||||
$Value = $Kernel::OM->Get('Kernel::System::Valid')->ValidLookup(
|
||||
ValidID => $HistoryEntry->{$ContentNewOrOld},
|
||||
);
|
||||
}
|
||||
elsif ( $Type eq 'Object' ) {
|
||||
|
||||
# get the UpdateID (ConditionID or ExpressionID or ActionID)
|
||||
# and the AttributeID
|
||||
if ( $HistoryEntry->{$ContentNewOrOld} =~ m{ %% }xms ) {
|
||||
( $HistoryEntry->{UpdateID}, $HistoryEntry->{$ContentNewOrOld} ) = split m/%%/,
|
||||
$HistoryEntry->{$ContentNewOrOld};
|
||||
}
|
||||
|
||||
# lookup the object name
|
||||
$Value = $Cache->{ObjectList}->{ $HistoryEntry->{$ContentNewOrOld} };
|
||||
|
||||
}
|
||||
elsif ( $Type eq 'Attribute' ) {
|
||||
|
||||
# get the UpdateID (ConditionID or ExpressionID or ActionID)
|
||||
# and the AttributeID
|
||||
if ( $HistoryEntry->{$ContentNewOrOld} =~ m{ %% }xms ) {
|
||||
( $HistoryEntry->{UpdateID}, $HistoryEntry->{$ContentNewOrOld} ) = split m/%%/,
|
||||
$HistoryEntry->{$ContentNewOrOld};
|
||||
}
|
||||
|
||||
# lookup the attribute name
|
||||
$Value = $Cache->{AttributeList}->{ $HistoryEntry->{$ContentNewOrOld} };
|
||||
}
|
||||
elsif ( $Type eq 'Operator' ) {
|
||||
|
||||
# get the UpdateID (ConditionID or ExpressionID or ActionID)
|
||||
# and the AttributeID
|
||||
if ( $HistoryEntry->{$ContentNewOrOld} =~ m{ %% }xms ) {
|
||||
( $HistoryEntry->{UpdateID}, $HistoryEntry->{$ContentNewOrOld} ) = split m/%%/,
|
||||
$HistoryEntry->{$ContentNewOrOld};
|
||||
}
|
||||
|
||||
# lookup the operator name
|
||||
$Value = $Cache->{OperatorList}->{ $HistoryEntry->{$ContentNewOrOld} };
|
||||
}
|
||||
else {
|
||||
return $LayoutObject->ErrorScreen(
|
||||
Message => $LayoutObject->{LanguageObject}
|
||||
->Translate( 'Unknown type "%s" encountered!', $Type ),
|
||||
Comment => Translatable('Please contact the administrator.'),
|
||||
);
|
||||
}
|
||||
|
||||
# E.g. the usernames should not be translated
|
||||
my $TranslatedValue = $TranslationNeeded
|
||||
?
|
||||
$LayoutObject->{LanguageObject}->Translate($Value)
|
||||
:
|
||||
$Value;
|
||||
|
||||
$HistoryEntry->{$ContentNewOrOld} = sprintf '%s (ID=%s)',
|
||||
$TranslatedValue, $HistoryEntry->{$ContentNewOrOld};
|
||||
}
|
||||
else {
|
||||
$HistoryEntry->{$ContentNewOrOld} = '';
|
||||
}
|
||||
|
||||
# The content has changed, so change the displayed fieldname as well
|
||||
$DisplayedFieldname = $Type;
|
||||
}
|
||||
elsif ( $HistoryEntry->{Fieldname} eq 'CABCustomers' ) {
|
||||
|
||||
# ContentNew and ContentOld contain a '%%' seperated list of customer user ids
|
||||
# reformat it as a comma separated list
|
||||
$HistoryEntry->{$ContentNewOrOld} =~ s{ % % }{,}xmsg;
|
||||
}
|
||||
elsif ( $HistoryEntry->{Fieldname} eq 'CABAgents' ) {
|
||||
|
||||
# ContentNew and ContentOld contain a '%%' separated list of user ids
|
||||
# look up the login names from the user ids and
|
||||
# format it as a comma separated list
|
||||
my @UserIDs = split m/%%/, $HistoryEntry->{$ContentNewOrOld};
|
||||
my @UserLogins = map { $UserObject->UserLookup( UserID => $_ ) } @UserIDs;
|
||||
$HistoryEntry->{$ContentNewOrOld} = join ',', @UserLogins;
|
||||
}
|
||||
elsif (
|
||||
$HistoryEntry->{Fieldname} eq 'ExpressionConjunction'
|
||||
|| $HistoryEntry->{Fieldname} eq 'Name'
|
||||
|| $HistoryEntry->{Fieldname} eq 'Comment'
|
||||
|| $HistoryEntry->{Fieldname} eq 'Selector'
|
||||
|| $HistoryEntry->{Fieldname} eq 'ActionValue'
|
||||
|| $HistoryEntry->{Fieldname} eq 'CompareValue'
|
||||
)
|
||||
{
|
||||
|
||||
# get the UpdateID (ConditionID or ExpressionID or ActionID)
|
||||
# and the AttributeID
|
||||
if ( $HistoryEntry->{$ContentNewOrOld} =~ m{ %% }xms ) {
|
||||
( $HistoryEntry->{UpdateID}, $HistoryEntry->{$ContentNewOrOld} ) = split m/%%/,
|
||||
$HistoryEntry->{$ContentNewOrOld};
|
||||
}
|
||||
}
|
||||
|
||||
# replace HTML breaks with single space
|
||||
$HistoryEntry->{$ContentNewOrOld} =~ s{ < br \s* /? > }{ }xmsg;
|
||||
}
|
||||
}
|
||||
|
||||
# translate fieldname for display
|
||||
$DisplayedFieldname = $LayoutObject->{LanguageObject}->Translate(
|
||||
$DisplayedFieldname,
|
||||
);
|
||||
|
||||
# get HTML utils object
|
||||
my $HTMLUtilsObject = $Kernel::OM->Get('Kernel::System::HTMLUtils');
|
||||
|
||||
# trim strings to a max length of $MaxLength
|
||||
my $ContentNew = $HTMLUtilsObject->ToAscii(
|
||||
String => $HistoryEntry->{ContentNew} || '',
|
||||
);
|
||||
my $ContentOld = $HTMLUtilsObject->ToAscii(
|
||||
String => $HistoryEntry->{ContentOld} || '',
|
||||
);
|
||||
|
||||
# show [...] for too long strings
|
||||
for my $Content ( $ContentNew, $ContentOld ) {
|
||||
if ( $Content && ( length $Content > $MaxLength ) ) {
|
||||
$Content = substr( $Content, 0, $MaxLength ) . '[...]';
|
||||
}
|
||||
}
|
||||
|
||||
# build description array
|
||||
my @Description = ( $DisplayedFieldname || '' );
|
||||
|
||||
# add the ID of the Condition, Expression or Action that was updated
|
||||
if (
|
||||
$HistoryType eq 'ConditionUpdate'
|
||||
|| $HistoryType eq 'ExpressionUpdate'
|
||||
|| $HistoryType eq 'ActionUpdate'
|
||||
)
|
||||
{
|
||||
if ( $HistoryEntry->{UpdateID} ) {
|
||||
push @Description, $HistoryEntry->{UpdateID};
|
||||
}
|
||||
}
|
||||
|
||||
# set description
|
||||
$Data{Content} = join '%%', @Description, $ContentNew, $ContentOld;
|
||||
}
|
||||
else {
|
||||
$Data{Content} = $HistoryEntry->{ContentNew};
|
||||
}
|
||||
|
||||
# replace text
|
||||
if ( $Data{Content} ) {
|
||||
|
||||
# remove leading %%
|
||||
$Data{Content} =~ s{ \A %% }{}xmsg;
|
||||
|
||||
# split the content by %%
|
||||
my @Values = split m/%%/, $Data{Content};
|
||||
|
||||
# for what item type is this history entry
|
||||
my $HistoryItemType = 'Change';
|
||||
if ( $HistoryType =~ m{ \A WorkOrder }xms ) {
|
||||
$HistoryItemType = 'WorkOrder';
|
||||
}
|
||||
|
||||
# for workorder entries that still exists, show workorderid
|
||||
my $HistoryEntryType = $Data{HistoryType};
|
||||
if ( $HistoryEntry->{WorkOrderID} ) {
|
||||
$HistoryEntryType .= 'WithWorkOrderID';
|
||||
unshift @Values, $HistoryEntry->{WorkOrderID};
|
||||
}
|
||||
|
||||
# handle condition add with id
|
||||
if ( $HistoryEntryType eq 'ConditionAdd' && !$HistoryEntry->{Fieldname} ) {
|
||||
$HistoryEntryType .= 'ID';
|
||||
}
|
||||
|
||||
# handle expression add with id
|
||||
if ( $HistoryEntryType eq 'ExpressionAdd' && !$HistoryEntry->{Fieldname} ) {
|
||||
$HistoryEntryType .= 'ID';
|
||||
}
|
||||
|
||||
# handle action add with id
|
||||
if ( $HistoryEntryType eq 'ActionAdd' && !$HistoryEntry->{Fieldname} ) {
|
||||
$HistoryEntryType .= 'ID';
|
||||
}
|
||||
|
||||
# useful for debugging, can be added to dtl to see the untranslated output
|
||||
$Data{ContentUntranslated} = $Data{Content};
|
||||
|
||||
# show 'nice' output with variable substitution
|
||||
$Data{Content} = $LayoutObject->{LanguageObject}->Translate(
|
||||
$HistoryStrings{ $HistoryItemType . 'History::' . $HistoryEntryType },
|
||||
@Values,
|
||||
);
|
||||
|
||||
# remove not needed place holder
|
||||
$Data{Content} =~ s{ % s }{}xmsg;
|
||||
}
|
||||
|
||||
$LayoutObject->Block(
|
||||
Name => 'Row',
|
||||
Data => {%Data},
|
||||
);
|
||||
|
||||
# show a 'more info' link
|
||||
if (
|
||||
(
|
||||
$HistoryEntry->{ContentNew}
|
||||
&& length( $HistoryEntry->{ContentNew} ) > $MaxLength
|
||||
)
|
||||
|| (
|
||||
$HistoryEntry->{ContentOld}
|
||||
&& length( $HistoryEntry->{ContentOld} ) > $MaxLength
|
||||
)
|
||||
)
|
||||
{
|
||||
|
||||
# is it a ChangeHistoryZoom or a WorkOrderHistoryZoom?
|
||||
my $ZoomType = 'Change';
|
||||
|
||||
if ( $HistoryType =~ m{ \A WorkOrder }xms && $HistoryEntry->{WorkOrderID} ) {
|
||||
$ZoomType = 'WorkOrder';
|
||||
}
|
||||
|
||||
# show historyzoom block
|
||||
$LayoutObject->Block(
|
||||
Name => 'ShowHistoryZoom',
|
||||
Data => {
|
||||
%Data,
|
||||
ZoomType => $ZoomType,
|
||||
},
|
||||
);
|
||||
}
|
||||
|
||||
# don't show a link
|
||||
else {
|
||||
$LayoutObject->Block(
|
||||
Name => 'NoHistoryZoom',
|
||||
);
|
||||
}
|
||||
|
||||
# show link to workorder for WorkOrderAdd event - if the workorder still exists
|
||||
if (
|
||||
$HistoryEntry->{HistoryType} =~ m{ \A WorkOrder }xms
|
||||
&& $HistoryEntry->{WorkOrderID}
|
||||
&& $WorkOrderIDLookup{ $HistoryEntry->{WorkOrderID} }
|
||||
)
|
||||
{
|
||||
|
||||
# show link
|
||||
$LayoutObject->Block(
|
||||
Name => 'ShowWorkOrderZoom',
|
||||
Data => {%Data},
|
||||
);
|
||||
}
|
||||
|
||||
# don't show any link
|
||||
else {
|
||||
$LayoutObject->Block(
|
||||
Name => 'NoWorkOrderZoom',
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
# output header
|
||||
my $Output = $LayoutObject->Header(
|
||||
Type => 'Small',
|
||||
Title => Translatable('Change History'),
|
||||
);
|
||||
|
||||
# start template output
|
||||
$Output .= $LayoutObject->Output(
|
||||
TemplateFile => 'AgentITSMChangeHistory',
|
||||
Data => {
|
||||
%Param,
|
||||
%{$Change},
|
||||
},
|
||||
);
|
||||
|
||||
# add footer
|
||||
$Output .= $LayoutObject->Footer(
|
||||
Type => 'Small',
|
||||
);
|
||||
|
||||
return $Output;
|
||||
}
|
||||
|
||||
1;
|
||||
Reference in New Issue
Block a user