Files
scripts/Perl OTRS/Kernel/System/ITSMConfigItem/Event/DoHistory.pm
2024-10-14 00:08:40 +02:00

168 lines
3.8 KiB
Perl

# --
# 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::System::ITSMConfigItem::Event::DoHistory;
use strict;
use warnings;
our @ObjectDependencies = (
'Kernel::System::ITSMConfigItem',
'Kernel::System::Log',
);
=head1 NAME
Kernel::System::ITSMConfigItem::Event::DoHistory - Event handler that does the history
=head1 PUBLIC INTERFACE
=head2 new()
create an object
use Kernel::System::ObjectManager;
local $Kernel::OM = Kernel::System::ObjectManager->new();
my $DoHistoryObject = $Kernel::OM->Get('Kernel::System::ITSMConfigItem::Event::DoHistory');
=cut
sub new {
my ( $Type, %Param ) = @_;
# allocate new hash for object
my $Self = {};
bless( $Self, $Type );
return $Self;
}
=head2 Run()
This method handles the event.
$DoHistoryObject->Run(
Event => 'ConfigItemCreate',
Data => {
Comment => 'new value: 1',
ConfigItemID => 123,
},
UserID => 1,
);
=cut
sub Run {
my ( $Self, %Param ) = @_;
# as DefinitionCreate does not belong to an item, we don't create
# a history entry
if ( $Param{Event} && $Param{Event} eq 'DefinitionCreate' ) {
return;
}
# check needed stuff
for my $Needed (qw(Data Event UserID)) {
if ( !$Param{$Needed} ) {
$Kernel::OM->Get('Kernel::System::Log')->Log(
Priority => 'error',
Message => "Need $Needed!",
);
return;
}
}
# due to consistency with ticket history, we need HistoryType
$Param{HistoryType} = $Param{Event};
# dispatch table for all events
my %Dispatcher = (
ConfigItemCreate => \&_HistoryAdd,
ConfigItemDelete => \&_ConfigItemDelete,
LinkAdd => \&_HistoryAdd,
LinkDelete => \&_HistoryAdd,
NameUpdate => \&_HistoryAdd,
IncidentStateUpdate => \&_HistoryAdd,
DeploymentStateUpdate => \&_HistoryAdd,
DefinitionUpdate => \&_HistoryAdd,
VersionCreate => \&_HistoryAdd,
ValueUpdate => \&_HistoryAdd,
DefinitionCreate => \&_HistoryAdd,
VersionDelete => \&_HistoryAdd,
AttachmentAddPost => \&_HistoryAdd,
AttachmentDeletePost => \&_HistoryAdd,
);
# error handling
if ( !exists $Dispatcher{ $Param{Event} } ) {
$Kernel::OM->Get('Kernel::System::Log')->Log(
Priority => 'error',
Message => 'non existant history type: ' . $Param{Event},
);
return;
}
# call callback
my $Sub = $Dispatcher{ $Param{Event} };
$Self->$Sub(
%Param,
%{ $Param{Data} },
);
return 1;
}
=head1 INTERNAL INTERFACE
=head2 _ConfigItemDelete()
history's event handler for ConfigItemDelete
=cut
sub _ConfigItemDelete {
my ( $Self, %Param ) = @_;
# delete history
$Kernel::OM->Get('Kernel::System::ITSMConfigItem')->HistoryDelete(
ConfigItemID => $Param{ConfigItemID},
);
return 1;
}
=head2 _HistoryAdd()
history's default event handler.
=cut
sub _HistoryAdd {
my ( $Self, %Param ) = @_;
# add history entry
$Kernel::OM->Get('Kernel::System::ITSMConfigItem')->HistoryAdd(
%Param,
);
return 1;
}
1;
=head1 TERMS AND CONDITIONS
This software is part of the OTRS project (L<https://otrs.org/>).
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 L<https://www.gnu.org/licenses/gpl-3.0.txt>.
=cut