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
201
202
203
204
205
206
207
208
209
210
211
|
# --
# 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::Console::Command::Maint::PostMaster::Read;
use strict;
use warnings;
use parent qw(Kernel::System::Console::BaseCommand);
our @ObjectDependencies = (
'Kernel::System::CommunicationLog',
'Kernel::System::Main',
);
sub Configure {
my ( $Self, %Param ) = @_;
$Self->Description('Read incoming email from STDIN.');
$Self->AddOption(
Name => 'target-queue',
Description => "Preselect a target queue by name.",
Required => 0,
HasValue => 1,
ValueRegex => qr/.*/smx,
);
$Self->AddOption(
Name => 'untrusted',
Description => "This will cause X-OTRS email headers to be ignored.",
Required => 0,
HasValue => 0,
);
return;
}
sub Run {
my ( $Self, %Param ) = @_;
# start a new incoming communication
my $CommunicationLogObject = $Kernel::OM->Create(
'Kernel::System::CommunicationLog',
ObjectParams => {
Transport => 'Email',
Direction => 'Incoming',
AccountType => 'STDIN',
},
);
# start object log for the incoming connection
$CommunicationLogObject->ObjectLogStart( ObjectLogType => 'Connection' );
$CommunicationLogObject->ObjectLog(
ObjectLogType => 'Connection',
Priority => 'Debug',
Key => 'Kernel::System::Console::Command::Maint::PostMaster::Read',
Value => 'Read email from STDIN.',
);
# get email from SDTIN
my @Email = <STDIN>; ## no critic
if ( !@Email ) {
$CommunicationLogObject->ObjectLog(
ObjectLogType => 'Connection',
Priority => 'Error',
Key => 'Kernel::System::Console::Command::Maint::PostMaster::Read',
Value => 'Got no email on STDIN!',
);
$CommunicationLogObject->ObjectLogStop(
ObjectLogType => 'Connection',
Status => 'Failed',
);
$CommunicationLogObject->CommunicationStop( Status => 'Failed' );
return $Self->ExitCodeError(1);
}
$CommunicationLogObject->ObjectLog(
ObjectLogType => 'Connection',
Priority => 'Debug',
Key => 'Kernel::System::Console::Command::Maint::PostMaster::Read',
Value => 'Email with ' . ( scalar @Email ) . ' lines successfully read from STDIN.',
);
# start object log for the email processing
$CommunicationLogObject->ObjectLogStart( ObjectLogType => 'Message' );
# remember the return code to stop the communictaion later with a proper status
my $PostMasterReturnCode = 0;
# Wrap the main part of the script in an "eval" block so that any
# unexpected (but probably transient) fatal errors (such as the
# database being unavailable) can be trapped without causing a
# bounce
eval {
$CommunicationLogObject->ObjectLog(
ObjectLogType => 'Message',
Priority => 'Debug',
Key => 'Kernel::System::Console::Command::Maint::PostMaster::Read',
Value => 'Processing email with PostMaster module.',
);
my $PostMasterObject = $Kernel::OM->Create(
'Kernel::System::PostMaster',
ObjectParams => {
CommunicationLogObject => $CommunicationLogObject,
Email => \@Email,
Trusted => $Self->GetOption('untrusted') ? 0 : 1,
},
);
my @Return = $PostMasterObject->Run(
Queue => $Self->GetOption('target-queue'),
);
if ( !$Return[0] ) {
$CommunicationLogObject->ObjectLog(
ObjectLogType => 'Message',
Priority => 'Error',
Key => 'Kernel::System::Console::Command::Maint::PostMaster::Read',
Value => 'PostMaster module exited with errors, could not process email. Please refer to the log!',
);
$CommunicationLogObject->CommunicationStop( Status => 'Failed' );
die "Could not process email. Please refer to the log!\n";
}
my $Dump = $Kernel::OM->Get('Kernel::System::Main')->Dump( \@Return );
$CommunicationLogObject->ObjectLog(
ObjectLogType => 'Message',
Priority => 'Debug',
Key => 'Kernel::System::Console::Command::Maint::PostMaster::Read',
Value => "Email processing with PostMaster module completed, return data: $Dump",
);
$PostMasterReturnCode = $Return[0];
};
if ($@) {
# An unexpected problem occurred (for example, the database was
# unavailable). Return an EX_TEMPFAIL error to cause the mail
# program to requeue the message instead of immediately bouncing
# it; see sysexits.h. Most mail programs will retry an
# EX_TEMPFAIL delivery for about four days, then bounce the
# message.)
my $Message = $@;
$CommunicationLogObject->ObjectLog(
ObjectLogType => 'Message',
Priority => 'Error',
Key => 'Kernel::System::Console::Command::Maint::PostMaster::Read',
Value => "An unexpected error occurred, message: $Message",
);
$CommunicationLogObject->ObjectLogStop(
ObjectLogType => 'Message',
Status => 'Failed',
);
$CommunicationLogObject->ObjectLogStop(
ObjectLogType => 'Connection',
Status => 'Failed',
);
$CommunicationLogObject->CommunicationStop( Status => 'Failed' );
return $Self->ExitCodeError(75);
}
$CommunicationLogObject->ObjectLog(
ObjectLogType => 'Connection',
Priority => 'Debug',
Key => 'Kernel::System::Console::Command::Maint::PostMaster::Read',
Value => 'Closing connection from STDIN.',
);
$CommunicationLogObject->ObjectLogStop(
ObjectLogType => 'Message',
Status => 'Successful',
);
$CommunicationLogObject->ObjectLogStop(
ObjectLogType => 'Connection',
Status => 'Successful',
);
my %ReturnCodeMap = (
0 => 'Failed', # error (also false)
1 => 'Successful', # new ticket created
2 => 'Successful', # follow up / open/reopen
3 => 'Successful', # follow up / close -> new ticket
4 => 'Failed', # follow up / close -> reject
5 => 'Successful', # ignored (because of X-OTRS-Ignore header)
);
$CommunicationLogObject->CommunicationStop(
Status => $ReturnCodeMap{$PostMasterReturnCode} // 'Failed',
);
return $Self->ExitCodeOk();
}
1;
|
