516 lines
12 KiB
Perl
516 lines
12 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::LinkObject::ITSMChange;
|
|
|
|
use strict;
|
|
use warnings;
|
|
|
|
our @ObjectDependencies = (
|
|
'Kernel::Config',
|
|
'Kernel::System::ITSMChange',
|
|
'Kernel::System::Log',
|
|
);
|
|
|
|
=head1 NAME
|
|
|
|
Kernel::System::LinkObject::ITSMChange - LinkObject backend for ITSMChange
|
|
|
|
=cut
|
|
|
|
=head2 new()
|
|
|
|
Create an object.
|
|
|
|
use Kernel::System::ObjectManager;
|
|
local $Kernel::OM = Kernel::System::ObjectManager->new();
|
|
my $LinkObjectITSMChangeObject = $Kernel::OM->Get('Kernel::System::LinkObject::ITSMChange');
|
|
|
|
=cut
|
|
|
|
sub new {
|
|
my ( $Type, %Param ) = @_;
|
|
|
|
# allocate new hash for object
|
|
my $Self = {};
|
|
bless( $Self, $Type );
|
|
|
|
return $Self;
|
|
}
|
|
|
|
=head2 LinkListWithData()
|
|
|
|
Fill up the link list with data
|
|
|
|
$Success = $LinkObjectBackend->LinkListWithData(
|
|
LinkList => $HashRef,
|
|
UserID => 1,
|
|
);
|
|
|
|
=cut
|
|
|
|
sub LinkListWithData {
|
|
my ( $Self, %Param ) = @_;
|
|
|
|
# check needed stuff
|
|
for my $Argument (qw(LinkList UserID)) {
|
|
if ( !$Param{$Argument} ) {
|
|
$Kernel::OM->Get('Kernel::System::Log')->Log(
|
|
Priority => 'error',
|
|
Message => "Need $Argument!",
|
|
);
|
|
return;
|
|
}
|
|
}
|
|
|
|
# check link list
|
|
if ( ref $Param{LinkList} ne 'HASH' ) {
|
|
$Kernel::OM->Get('Kernel::System::Log')->Log(
|
|
Priority => 'error',
|
|
Message => 'LinkList must be a hash reference!',
|
|
);
|
|
return;
|
|
}
|
|
|
|
for my $LinkType ( sort keys %{ $Param{LinkList} } ) {
|
|
|
|
for my $Direction ( sort keys %{ $Param{LinkList}->{$LinkType} } ) {
|
|
|
|
CHANGEID:
|
|
for my $ChangeID ( sort keys %{ $Param{LinkList}->{$LinkType}->{$Direction} } ) {
|
|
|
|
# get change data
|
|
my $ChangeData = $Kernel::OM->Get('Kernel::System::ITSMChange')->ChangeGet(
|
|
ChangeID => $ChangeID,
|
|
UserID => $Param{UserID},
|
|
);
|
|
|
|
# remove id from hash if ChangeGet() returns no results
|
|
if ( !$ChangeData ) {
|
|
delete $Param{LinkList}->{$LinkType}->{$Direction}->{$ChangeID};
|
|
next CHANGEID;
|
|
}
|
|
|
|
# add change data
|
|
$Param{LinkList}->{$LinkType}->{$Direction}->{$ChangeID} = $ChangeData;
|
|
}
|
|
}
|
|
}
|
|
|
|
return 1;
|
|
}
|
|
|
|
=head2 ObjectPermission()
|
|
|
|
Checks read permission for a given object and UserID.
|
|
|
|
$Permission = $LinkObject->ObjectPermission(
|
|
Object => 'ITSMChange',
|
|
Key => 123,
|
|
UserID => 1,
|
|
);
|
|
|
|
=cut
|
|
|
|
sub ObjectPermission {
|
|
my ( $Self, %Param ) = @_;
|
|
|
|
# check needed stuff
|
|
for my $Argument (qw(Object Key UserID)) {
|
|
if ( !$Param{$Argument} ) {
|
|
$Kernel::OM->Get('Kernel::System::Log')->Log(
|
|
Priority => 'error',
|
|
Message => "Need $Argument!",
|
|
);
|
|
return;
|
|
}
|
|
}
|
|
|
|
# get config of change zoom frontend module
|
|
$Self->{Config} = $Kernel::OM->Get('Kernel::Config')->Get('ITSMChange::Frontend::AgentITSMChangeZoom');
|
|
|
|
# check permissions
|
|
my $Access = $Kernel::OM->Get('Kernel::System::ITSMChange')->Permission(
|
|
Type => $Self->{Config}->{Permission},
|
|
ChangeID => $Param{Key},
|
|
UserID => $Param{UserID},
|
|
);
|
|
|
|
return $Access;
|
|
}
|
|
|
|
=head2 ObjectDescriptionGet()
|
|
|
|
Return a hash of object descriptions.
|
|
|
|
Return
|
|
%Description = (
|
|
Normal => "Change# 2009102110001674",
|
|
Long => "Change# 2009102110001674: The Change Title",
|
|
);
|
|
|
|
%Description = $LinkObject->ObjectDescriptionGet(
|
|
Key => 123,
|
|
UserID => 1,
|
|
);
|
|
|
|
=cut
|
|
|
|
sub ObjectDescriptionGet {
|
|
my ( $Self, %Param ) = @_;
|
|
|
|
# check needed stuff
|
|
for my $Argument (qw(Object Key UserID)) {
|
|
if ( !$Param{$Argument} ) {
|
|
$Kernel::OM->Get('Kernel::System::Log')->Log(
|
|
Priority => 'error',
|
|
Message => "Need $Argument!",
|
|
);
|
|
return;
|
|
}
|
|
}
|
|
|
|
# create description
|
|
my %Description = (
|
|
Normal => 'Change',
|
|
Long => 'Change',
|
|
);
|
|
|
|
return %Description if $Param{Mode} && $Param{Mode} eq 'Temporary';
|
|
|
|
# get change data
|
|
my $ChangeData = $Kernel::OM->Get('Kernel::System::ITSMChange')->ChangeGet(
|
|
ChangeID => $Param{Key},
|
|
UserID => $Param{UserID},
|
|
);
|
|
|
|
return if !$ChangeData;
|
|
return if !%{$ChangeData};
|
|
|
|
# define description text
|
|
my $ChangeHook = $Kernel::OM->Get('Kernel::Config')->Get('ITSMChange::Hook');
|
|
my $DescriptionText = "$ChangeHook $ChangeData->{ChangeNumber}";
|
|
|
|
# create description
|
|
%Description = (
|
|
Normal => $DescriptionText,
|
|
Long => "$DescriptionText: $ChangeData->{ChangeTitle}",
|
|
);
|
|
|
|
return %Description;
|
|
}
|
|
|
|
=head2 ObjectSearch()
|
|
|
|
Return a hash list of the search results.
|
|
|
|
$SearchList = $LinkObjectBackend->ObjectSearch(
|
|
SearchParams => $HashRef, # (optional)
|
|
UserID => 1,
|
|
);
|
|
|
|
$SearchList = {
|
|
NOTLINKED => {
|
|
Source => {
|
|
12 => $DataOfItem12,
|
|
212 => $DataOfItem212,
|
|
332 => $DataOfItem332,
|
|
},
|
|
},
|
|
};
|
|
|
|
=cut
|
|
|
|
sub ObjectSearch {
|
|
my ( $Self, %Param ) = @_;
|
|
|
|
# check needed stuff
|
|
if ( !$Param{UserID} ) {
|
|
$Kernel::OM->Get('Kernel::System::Log')->Log(
|
|
Priority => 'error',
|
|
Message => 'Need UserID!',
|
|
);
|
|
return;
|
|
}
|
|
|
|
# set default params
|
|
$Param{SearchParams} ||= {};
|
|
|
|
# add wildcards
|
|
my %Search;
|
|
for my $Element (qw(ChangeNumber ChangeTitle WorkOrderTitle)) {
|
|
if ( $Param{SearchParams}->{$Element} ) {
|
|
$Search{$Element} = '*' . $Param{SearchParams}->{$Element} . '*';
|
|
}
|
|
}
|
|
|
|
# search the changes
|
|
# no need to use OrderBy here, because it is sorted in TableCreateComplex and TableCreateSimple
|
|
my $ChangeIDsRef = $Kernel::OM->Get('Kernel::System::ITSMChange')->ChangeSearch(
|
|
%{ $Param{SearchParams} },
|
|
%Search,
|
|
UsingWildcards => 1,
|
|
MirrorDB => 1,
|
|
|
|
# TODO:
|
|
# use sysconfig option for 'limit' instead, decide wheater this option would be only
|
|
# valid for linking changes, or just use a global setting for all linking stuff
|
|
Limit => 200,
|
|
|
|
UserID => $Param{UserID},
|
|
);
|
|
|
|
my %SearchList;
|
|
CHANGEID:
|
|
for my $ChangeID ( @{$ChangeIDsRef} ) {
|
|
|
|
# get change data
|
|
my $ChangeData = $Kernel::OM->Get('Kernel::System::ITSMChange')->ChangeGet(
|
|
ChangeID => $ChangeID,
|
|
UserID => $Param{UserID},
|
|
);
|
|
|
|
next ChangeID if !$ChangeData;
|
|
|
|
# add change data
|
|
$SearchList{NOTLINKED}->{Source}->{$ChangeID} = $ChangeData;
|
|
}
|
|
|
|
return \%SearchList;
|
|
}
|
|
|
|
=head2 LinkAddPre()
|
|
|
|
Link add pre event module.
|
|
|
|
$True = $LinkObject->LinkAddPre(
|
|
Key => 123,
|
|
SourceObject => 'ITSMChange',
|
|
SourceKey => 321,
|
|
Type => 'Normal',
|
|
State => 'Valid',
|
|
UserID => 1,
|
|
);
|
|
|
|
or
|
|
|
|
$True = $LinkObject->LinkAddPre(
|
|
Key => 123,
|
|
TargetObject => 'ITSMChange',
|
|
TargetKey => 321,
|
|
Type => 'Normal',
|
|
State => 'Valid',
|
|
UserID => 1,
|
|
);
|
|
|
|
=cut
|
|
|
|
sub LinkAddPre {
|
|
my ( $Self, %Param ) = @_;
|
|
|
|
# check needed stuff
|
|
for my $Argument (qw(Key Type State UserID)) {
|
|
if ( !$Param{$Argument} ) {
|
|
$Kernel::OM->Get('Kernel::System::Log')->Log(
|
|
Priority => 'error',
|
|
Message => "Need $Argument!",
|
|
);
|
|
return;
|
|
}
|
|
}
|
|
|
|
# do not trigger event for temporary links
|
|
return 1 if $Param{State} eq 'Temporary';
|
|
|
|
return 1;
|
|
}
|
|
|
|
=head2 LinkAddPost()
|
|
|
|
Link add pre event module.
|
|
|
|
$True = $LinkObject->LinkAddPost(
|
|
Key => 123,
|
|
SourceObject => 'ITSMChange',
|
|
SourceKey => 321,
|
|
Type => 'Normal',
|
|
State => 'Valid',
|
|
UserID => 1,
|
|
);
|
|
|
|
or
|
|
|
|
$True = $LinkObject->LinkAddPost(
|
|
Key => 123,
|
|
TargetObject => 'ITSMChange',
|
|
TargetKey => 321,
|
|
Type => 'Normal',
|
|
State => 'Valid',
|
|
UserID => 1,
|
|
);
|
|
|
|
=cut
|
|
|
|
sub LinkAddPost {
|
|
my ( $Self, %Param ) = @_;
|
|
|
|
# check needed stuff
|
|
for my $Argument (qw(Key Type State UserID)) {
|
|
if ( !$Param{$Argument} ) {
|
|
$Kernel::OM->Get('Kernel::System::Log')->Log(
|
|
Priority => 'error',
|
|
Message => "Need $Argument!",
|
|
);
|
|
return;
|
|
}
|
|
}
|
|
|
|
# do not trigger event for temporary links
|
|
return 1 if $Param{State} eq 'Temporary';
|
|
|
|
# get information about linked object
|
|
my $ID = $Param{TargetKey} || $Param{SourceKey};
|
|
my $Object = $Param{TargetObject} || $Param{SourceObject};
|
|
|
|
# trigger ChangeLinkAddPost-Event
|
|
$Kernel::OM->Get('Kernel::System::ITSMChange')->EventHandler(
|
|
Event => 'ChangeLinkAddPost',
|
|
Data => {
|
|
ChangeID => $Param{Key},
|
|
Object => $Object, # the other object of the link
|
|
ID => $ID, # id of the other object
|
|
Type => $Param{Type}, # the link type
|
|
%Param,
|
|
},
|
|
UserID => $Param{UserID},
|
|
);
|
|
|
|
return 1;
|
|
}
|
|
|
|
=head2 LinkDeletePre()
|
|
|
|
Link delete pre event module.
|
|
|
|
$True = $LinkObject->LinkDeletePre(
|
|
Key => 123,
|
|
SourceObject => 'ITSMChange',
|
|
SourceKey => 321,
|
|
Type => 'Normal',
|
|
State => 'Valid',
|
|
UserID => 1,
|
|
);
|
|
|
|
or
|
|
|
|
$True = $LinkObject->LinkDeletePre(
|
|
Key => 123,
|
|
TargetObject => 'ITSMChange',
|
|
TargetKey => 321,
|
|
Type => 'Normal',
|
|
State => 'Valid',
|
|
UserID => 1,
|
|
);
|
|
|
|
=cut
|
|
|
|
sub LinkDeletePre {
|
|
my ( $Self, %Param ) = @_;
|
|
|
|
# check needed stuff
|
|
for my $Argument (qw(Key Type State UserID)) {
|
|
if ( !$Param{$Argument} ) {
|
|
$Kernel::OM->Get('Kernel::System::Log')->Log(
|
|
Priority => 'error',
|
|
Message => "Need $Argument!",
|
|
);
|
|
return;
|
|
}
|
|
}
|
|
|
|
# do not trigger event for temporary links
|
|
return 1 if $Param{State} eq 'Temporary';
|
|
|
|
return 1;
|
|
}
|
|
|
|
=head2 LinkDeletePost()
|
|
|
|
Link delete post event module.
|
|
|
|
$True = $LinkObject->LinkDeletePost(
|
|
Key => 123,
|
|
SourceObject => 'ITSMChange',
|
|
SourceKey => 321,
|
|
Type => 'Normal',
|
|
State => 'Valid',
|
|
UserID => 1,
|
|
);
|
|
|
|
or
|
|
|
|
$True = $LinkObject->LinkDeletePost(
|
|
Key => 123,
|
|
TargetObject => 'ITSMChange',
|
|
TargetKey => 321,
|
|
Type => 'Normal',
|
|
State => 'Valid',
|
|
UserID => 1,
|
|
);
|
|
|
|
=cut
|
|
|
|
sub LinkDeletePost {
|
|
my ( $Self, %Param ) = @_;
|
|
|
|
# check needed stuff
|
|
for my $Argument (qw(Key Type State UserID)) {
|
|
if ( !$Param{$Argument} ) {
|
|
$Kernel::OM->Get('Kernel::System::Log')->Log(
|
|
Priority => 'error',
|
|
Message => "Need $Argument!",
|
|
);
|
|
return;
|
|
}
|
|
}
|
|
|
|
# do not trigger event for temporary links
|
|
return 1 if $Param{State} eq 'Temporary';
|
|
|
|
# get information about linked object
|
|
my $ID = $Param{TargetKey} || $Param{SourceKey};
|
|
my $Object = $Param{TargetObject} || $Param{SourceObject};
|
|
|
|
# trigger ChangeLinkDeletePost-Event
|
|
$Kernel::OM->Get('Kernel::System::ITSMChange')->EventHandler(
|
|
Event => 'ChangeLinkDeletePost',
|
|
Data => {
|
|
ChangeID => $Param{Key},
|
|
Object => $Object, # the other object of the link
|
|
ID => $ID, # id of the other object
|
|
Type => $Param{Type}, # the link type
|
|
%Param,
|
|
},
|
|
UserID => $Param{UserID},
|
|
);
|
|
|
|
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
|