/usr/share/otrs/Kernel/GenericInterface/Operation.pm is in otrs2 6.0.5-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 | # --
# Copyright (C) 2001-2018 OTRS AG, http://otrs.com/
# --
# This software comes with ABSOLUTELY NO WARRANTY. For details, see
# the enclosed file COPYING for license information (AGPL). If you
# did not receive this file, see http://www.gnu.org/licenses/agpl.txt.
# --
package Kernel::GenericInterface::Operation;
use strict;
use warnings;
use Kernel::System::VariableCheck qw(IsStringWithData);
# prevent 'Used once' warning for Kernel::OM
use Kernel::System::ObjectManager;
our $ObjectManagerDisabled = 1;
=head1 NAME
Kernel::GenericInterface::Operation - GenericInterface Operation interface
=head1 DESCRIPTION
Operations are called by web service requests from remote
systems.
=head1 PUBLIC INTERFACE
=head2 new()
create an object.
use Kernel::GenericInterface::Debugger;
use Kernel::GenericInterface::Operation;
my $DebuggerObject = Kernel::GenericInterface::Debugger->new(
DebuggerConfig => {
DebugThreshold => 'debug',
TestMode => 0, # optional, in testing mode the data will not be written to the DB
# ...
},
WebserviceID => 12,
CommunicationType => Provider, # Requester or Provider
RemoteIP => 192.168.1.1, # optional
);
my $OperationObject = Kernel::GenericInterface::Operation->new(
DebuggerObject => $DebuggerObject,
Operation => 'TicketCreate', # the name of the operation in the web service
OperationType => 'Ticket::TicketCreate', # the local operation backend to use
WebserviceID => $WebserviceID, # ID of the currently used web service
);
=cut
sub new {
my ( $Type, %Param ) = @_;
my $Self = {};
bless( $Self, $Type );
# Check needed objects.
for my $Needed (qw(DebuggerObject Operation OperationType WebserviceID)) {
if ( !$Param{$Needed} ) {
return {
Success => 0,
ErrorMessage => "Got no $Needed!"
};
}
$Self->{$Needed} = $Param{$Needed};
}
# Check operation.
if ( !IsStringWithData( $Param{OperationType} ) ) {
return $Self->{DebuggerObject}->Error(
Summary => 'Got no Operation with content!',
);
}
# Load backend module.
my $GenericModule = 'Kernel::GenericInterface::Operation::' . $Param{OperationType};
if ( !$Kernel::OM->Get('Kernel::System::Main')->Require($GenericModule) ) {
return $Self->{DebuggerObject}->Error(
Summary => "Can't load operation backend module $GenericModule!"
);
}
$Self->{BackendObject} = $GenericModule->new(
%{$Self},
);
# Pass back error message from backend if backend module could not be executed.
return $Self->{BackendObject} if ref $Self->{BackendObject} ne $GenericModule;
return $Self;
}
=head2 Run()
perform the selected Operation.
my $Result = $OperationObject->Run(
Data => { # data payload before Operation
...
},
);
$Result = {
Success => 1, # 0 or 1
ErrorMessage => '', # in case of error
Data => { # result data payload after Operation
...
},
};
=cut
sub Run {
my ( $Self, %Param ) = @_;
# Start map on backend,
return $Self->{BackendObject}->Run(%Param);
}
=head2 HandleError()
handle error data of the configured remote web service.
my $Result = $InvokerObject->HandleError(
Data => { # data payload
...
},
);
$Result = {
Success => 1, # 0 or 1
ErrorMessage => '', # in case of error
Data => { # data payload after Invoker
...
},
};
=cut
sub HandleError {
my ( $Self, %Param ) = @_;
# Check data - only accept undef or hash ref
if ( defined $Param{Data} && ref $Param{Data} ne 'HASH' ) {
return $Self->{DebuggerObject}->Error(
Summary => 'Got Data but it is not a hash ref in Operation handler (HandleResponse)!'
);
}
return $Self->{BackendObject}->HandleError(%Param);
}
1;
=head1 TERMS AND CONDITIONS
This software is part of the OTRS project (L<http://otrs.org/>).
This software comes with ABSOLUTELY NO WARRANTY. For details, see
the enclosed file COPYING for license information (AGPL). If you
did not receive this file, see L<http://www.gnu.org/licenses/agpl.txt>.
=cut
|