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
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
|
# --
# Copyright (C) 2001-2021 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::Daemon::DaemonModules::SchedulerTaskWorker::GenericInterface;
use strict;
use warnings;
use parent qw(Kernel::System::Daemon::DaemonModules::BaseTaskWorker);
use Kernel::System::VariableCheck qw(:all);
use Storable;
our @ObjectDependencies = (
'Kernel::Config',
'Kernel::GenericInterface::Requester',
'Kernel::System::DateTime',
'Kernel::System::GenericInterface::Webservice',
'Kernel::System::Log',
'Kernel::System::Scheduler',
);
=head1 NAME
Kernel::System::Daemon::DaemonModules::SchedulerTaskWorker::GenericInterface - Scheduler daemon task handler module for GenericInterface
=head1 DESCRIPTION
This task handler executes scheduler tasks delegated by asynchronous invoker configuration
=head1 PUBLIC INTERFACE
=head2 new()
my $TaskHandlerObject = $Kernel::OM-Get('Kernel::System::Daemon::DaemonModules::SchedulerTaskWorker::GenericInterface');
=cut
sub new {
my ( $Type, %Param ) = @_;
my $Self = {};
bless( $Self, $Type );
$Self->{Debug} = $Param{Debug};
$Self->{WorkerName} = 'Worker: GenericInterface';
return $Self;
}
=head2 Run()
Performs the selected Task, causing an Invoker call via GenericInterface.
my $Result = $TaskHandlerObject->Run(
TaskID => 123,
TaskName => 'some name', # optional
Data => {
WebserviceID => $WebserviceID,
Invoker => 'configured_invoker',
Data => { # data payload for the Invoker
...
},
},
);
Returns:
$Result = 1; # or fail in case of an error
=cut
sub Run {
my ( $Self, %Param ) = @_;
# Check task params.
my $CheckResult = $Self->_CheckTaskParams(
NeededDataAttributes => [ 'WebserviceID', 'Invoker', 'Data' ],
%Param,
);
return if !$CheckResult;
if ( $Self->{Debug} ) {
print " $Self->{WorkerName} executes task: $Param{TaskName}\n";
}
my $Result = $Kernel::OM->Get('Kernel::GenericInterface::Requester')->Run(
WebserviceID => $Param{Data}->{WebserviceID},
Invoker => $Param{Data}->{Invoker},
Asynchronous => 1,
Data => Storable::dclone( $Param{Data}->{Data} ),
PastExecutionData => $Param{Data}->{PastExecutionData},
);
return 1 if $Result->{Success};
my $Webservice = $Kernel::OM->Get('Kernel::System::GenericInterface::Webservice')->WebserviceGet(
ID => $Param{Data}->{WebserviceID},
);
my $WebServiceName = $Webservice->{Name} // 'N/A';
# No further retries for request.
if (
!IsHashRefWithData( $Result->{Data} )
|| !$Result->{Data}->{ReSchedule}
)
{
my $ErrorMessage
= $Result->{ErrorMessage} || "$Param{Data}->{Invoker} execution failed without an error message";
$Self->_HandleError(
TaskName => "$Param{Data}->{Invoker} WebService: $WebServiceName",
TaskType => 'GenericInterface',
LogMessage => "There was an error executing $Param{Data}->{Invoker} ($WebServiceName): $ErrorMessage",
ErrorMessage => "$ErrorMessage",
);
return;
}
# Schedule request for another try.
# Use the execution time from the return data (if any).
my $ExecutionTime = $Result->{Data}->{ExecutionTime};
my $ExecutionDateTime;
# Check if execution time is valid.
if ( IsStringWithData($ExecutionTime) ) {
$ExecutionDateTime = $Kernel::OM->Create(
'Kernel::System::DateTime',
ObjectParams => {
String => $ExecutionTime,
},
);
if ( !$ExecutionDateTime ) {
$Kernel::OM->Get('Kernel::System::Log')->Log(
Priority => 'error',
Message =>
"WebService $WebServiceName, Invoker $Param{Data}->{Invoker} returned invalid execution time $ExecutionTime. Falling back to default!",
);
}
}
# Set default execution time.
if ( !$ExecutionTime || !$ExecutionDateTime ) {
# Get default time difference from config.
my $FutureTaskTimeDiff = int(
$Kernel::OM->Get('Kernel::Config')->Get('Daemon::SchedulerGenericInterfaceTaskManager::FutureTaskTimeDiff')
)
|| 300;
$ExecutionDateTime = $Kernel::OM->Create('Kernel::System::DateTime');
$ExecutionDateTime->Add( Seconds => $FutureTaskTimeDiff );
}
if ( $Self->{Debug} ) {
print " $Self->{WorkerName} re-schedule task: $Param{TaskName} for: $ExecutionDateTime->ToString()\n";
}
# Create a new task (replica) that will be executed in the future.
my $Success = $Kernel::OM->Get('Kernel::System::Scheduler')->TaskAdd(
ExecutionTime => $ExecutionDateTime->ToString(),
Type => 'GenericInterface',
Name => $Param{TaskName},
Attempts => 10,
Data => {
%{ $Param{Data} },
PastExecutionData => $Result->{Data}->{PastExecutionData},
},
);
if ( !$Success ) {
$Kernel::OM->Get('Kernel::System::Log')->Log(
Priority => 'error',
Message => "Could not re-schedule a task in future for task $Param{TaskName}",
);
}
return;
}
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
|
