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
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
|
# --
# 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::PostMaster::Filter;
use strict;
use warnings;
our @ObjectDependencies = (
'Kernel::System::DB',
'Kernel::System::Log',
);
=head1 NAME
Kernel::System::PostMaster::Filter
=head1 DESCRIPTION
All postmaster database filters
=head1 PUBLIC INTERFACE
=head2 new()
Don't use the constructor directly, use the ObjectManager instead:
my $PMFilterObject = $Kernel::OM->Get('Kernel::System::PostMaster::Filter');
=cut
sub new {
my ( $Type, %Param ) = @_;
# allocate new hash for object
my $Self = {};
bless( $Self, $Type );
return $Self;
}
=head2 FilterList()
get all filter
my %FilterList = $PMFilterObject->FilterList();
=cut
sub FilterList {
my ( $Self, %Param ) = @_;
# get database object
my $DBObject = $Kernel::OM->Get('Kernel::System::DB');
return if !$DBObject->Prepare(
SQL => 'SELECT f_name FROM postmaster_filter',
);
my %Data;
while ( my @Row = $DBObject->FetchrowArray() ) {
$Data{ $Row[0] } = $Row[0];
}
return %Data;
}
=head2 FilterAdd()
add a filter
$PMFilterObject->FilterAdd(
Name => 'some name',
StopAfterMatch => 0,
Match = [
{
Key => 'Subject',
Value => '^ADV: 123',
},
...
],
Not = [
{
Key => 'Subject',
Value => '1',
},
...
],
Set = [
{
Key => 'X-OTRS-Queue',
Value => 'Some::Queue',
},
...
],
);
=cut
sub FilterAdd {
my ( $Self, %Param ) = @_;
# check needed stuff
for (qw(Name StopAfterMatch Match Set)) {
if ( !defined $Param{$_} ) {
$Kernel::OM->Get('Kernel::System::Log')->Log(
Priority => 'error',
Message => "Need $_!"
);
return;
}
}
# get database object
my $DBObject = $Kernel::OM->Get('Kernel::System::DB');
my @Not = @{ $Param{Not} || [] };
for my $Type (qw(Match Set)) {
my @Data = @{ $Param{$Type} };
for my $Index ( 0 .. ( scalar @Data ) - 1 ) {
return if !$DBObject->Do(
SQL =>
'INSERT INTO postmaster_filter (f_name, f_stop, f_type, f_key, f_value, f_not)'
. ' VALUES (?, ?, ?, ?, ?, ?)',
Bind => [
\$Param{Name}, \$Param{StopAfterMatch}, \$Type,
\$Data[$Index]->{Key}, \$Data[$Index]->{Value}, \$Not[$Index]->{Value},
],
);
}
}
return 1;
}
=head2 FilterDelete()
delete a filter
$PMFilterObject->FilterDelete(
Name => '123',
);
=cut
sub FilterDelete {
my ( $Self, %Param ) = @_;
# check needed stuff
for (qw(Name)) {
if ( !defined $Param{$_} ) {
$Kernel::OM->Get('Kernel::System::Log')->Log(
Priority => 'error',
Message => "Need $_!"
);
return;
}
}
# get database object
my $DBObject = $Kernel::OM->Get('Kernel::System::DB');
return if !$DBObject->Do(
SQL => 'DELETE FROM postmaster_filter WHERE f_name = ?',
Bind => [ \$Param{Name} ],
);
return 1;
}
=head2 FilterGet()
get filter properties, returns HASH ref Match and Set
my %Data = $PMFilterObject->FilterGet(
Name => '132',
);
=cut
sub FilterGet {
my ( $Self, %Param ) = @_;
# check needed stuff
for (qw(Name)) {
if ( !defined $Param{$_} ) {
$Kernel::OM->Get('Kernel::System::Log')->Log(
Priority => 'error',
Message => "Need $_!"
);
return;
}
}
# get database object
my $DBObject = $Kernel::OM->Get('Kernel::System::DB');
return if !$DBObject->Prepare(
SQL =>
'SELECT f_type, f_key, f_value, f_name, f_stop, f_not'
. ' FROM postmaster_filter'
. ' WHERE f_name = ?'
. ' ORDER BY f_key, f_value',
Bind => [ \$Param{Name} ],
);
my %Data;
while ( my @Row = $DBObject->FetchrowArray() ) {
push @{ $Data{ $Row[0] } }, {
Key => $Row[1],
Value => $Row[2],
};
$Data{Name} = $Row[3];
$Data{StopAfterMatch} = $Row[4];
if ( $Row[0] eq 'Match' ) {
push @{ $Data{Not} }, {
Key => $Row[1],
Value => $Row[5],
};
}
}
return %Data;
}
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
|
