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
|
# --
# Copyright (C) 2001-2021 OTRS AG, https://otrs.com/
# Copyright (C) 2021 Znuny GmbH, https://znuny.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 https://www.gnu.org/licenses/gpl-3.0.txt.
# --
package scripts::test::sample::AsynchronousExecutor::TestAsynchronousExecutor;
use strict;
use warnings;
use parent qw(Kernel::System::AsynchronousExecutor);
our @ObjectDependencies = ();
=head1 NAME
scripts::test::sample::AsynchronousExecutor::TestAsynchronousExecutor - sample of a module with AsynchronousExecutor base class
=head1 SYNOPSIS
=head1 PUBLIC INTERFACE
=over 4
=cut
=item new()
use Kernel::System::ObjectManager;
local $Kernel::OM = Kernel::System::ObjectManager->new();
my $ModuleObject = $Kernel::OM->Get('scripts::test::sample::AsynchronousExecutor::TestAsynchronousExecutor');
=cut
sub new {
my ( $Type, %Param ) = @_;
my $Self = {};
bless( $Self, $Type );
return $Self;
}
=item Execute()
performs the selected test task.
my $Success = $TaskHandlerObject->Execute(
File => $Filename, # optional, create file $FileName
Success => 1, # 0 or 1, controls return value
);
Returns:
$Success = 1 # or fail in case of an error
=cut
sub Execute {
my ( $Self, %Param ) = @_;
# create temporary file
if ( $Param{File} ) {
my $Content = 123;
return if !$Self->_FileWrite(
Location => $Param{File},
Content => \$Content,
);
}
return $Param{Success};
}
sub ExecuteAsyc {
my ( $Self, %Param ) = @_;
# create a new task for the scheduler daemon
$Self->AsyncCall(
FunctionName => 'Execute',
FunctionParams => \%Param,
Attempts => 3,
MaximumParallelInstances => 1,
);
return 1;
}
sub ExecuteAsycWithObjectName {
my ( $Self, %Param ) = @_;
# create a new task for the scheduler daemon
$Self->AsyncCall(
ObjectName => 'scripts::test::sample::AsynchronousExecutor::TestAsynchronousExecutor',
FunctionName => 'Execute',
FunctionParams => \%Param,
Attempts => 3,
MaximumParallelInstances => 1,
);
return 1;
}
sub _FileWrite {
my ( $Self, %Param ) = @_;
if ( !$Param{Location} ) {
print STDERR "Need Location!\n";
return;
}
# filename clean up
$Param{Location} =~ s/\/\//\//g;
# set open mode (if file exists, lock it on open, done by '+<')
my $Exists;
if ( -f $Param{Location} ) {
$Exists = 1;
}
my $Mode = '>';
if ($Exists) {
$Mode = '+<';
}
if ( $Param{Mode} && $Param{Mode} =~ /^(utf8|utf\-8)/i ) {
$Mode = '>:utf8';
if ($Exists) {
$Mode = '+<:utf8';
}
}
# return if file can not open
my $FH;
if ( !open $FH, $Mode, $Param{Location} ) { ## no critic
print STDERR "Can't write '$Param{Location}': $!",
return;
}
# lock file (Exclusive Lock)
if ( !flock $FH, 2 ) {
print STDERR "Can't lock '$Param{Location}': $!";
}
# empty file first (needed if file is open by '+<')
truncate $FH, 0;
# write file if content is not undef
if ( defined ${ $Param{Content} } ) {
print $FH ${ $Param{Content} };
}
# write empty file if content is undef
else {
print $FH '';
}
# close the file handle
close $FH;
return $Param{Location};
}
1;
=back
=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
|
