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
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
|
/*-
* Copyright 2021 Vsevolod Stakhov
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#include "config.h"
#include "logger.h"
#include "expression.h"
#include "task.h"
#include "utlist.h"
#include "scan_result.h"
#include "composites.h"
#include <cmath>
#include <vector>
#include <variant>
#include "libutil/cxx/util.hxx"
#include "contrib/ankerl/unordered_dense.h"
#include "composites_internal.hxx"
#define msg_err_composites(...) rspamd_default_log_function(G_LOG_LEVEL_CRITICAL, \
"composites", task->task_pool->tag.uid, \
RSPAMD_LOG_FUNC, \
__VA_ARGS__)
#define msg_warn_composites(...) rspamd_default_log_function(G_LOG_LEVEL_WARNING, \
"composites", task->task_pool->tag.uid, \
RSPAMD_LOG_FUNC, \
__VA_ARGS__)
#define msg_info_composites(...) rspamd_default_log_function(G_LOG_LEVEL_INFO, \
"composites", task->task_pool->tag.uid, \
RSPAMD_LOG_FUNC, \
__VA_ARGS__)
#define msg_debug_composites(...) rspamd_conditional_debug_fast(NULL, task->from_addr, \
rspamd_composites_log_id, "composites", task->task_pool->tag.uid, \
RSPAMD_LOG_FUNC, \
__VA_ARGS__)
INIT_LOG_MODULE(composites)
namespace rspamd::composites {
static rspamd_expression_atom_t *rspamd_composite_expr_parse(const gchar *line, gsize len,
rspamd_mempool_t *pool,
gpointer ud, GError **err);
static gdouble rspamd_composite_expr_process(void *ud, rspamd_expression_atom_t *atom);
static gint rspamd_composite_expr_priority(rspamd_expression_atom_t *atom);
static void rspamd_composite_expr_destroy(rspamd_expression_atom_t *atom);
static void composites_foreach_callback(gpointer key, gpointer value, void *data);
const struct rspamd_atom_subr composite_expr_subr = {
.parse = rspamd::composites::rspamd_composite_expr_parse,
.process = rspamd::composites::rspamd_composite_expr_process,
.priority = rspamd::composites::rspamd_composite_expr_priority,
.destroy = rspamd::composites::rspamd_composite_expr_destroy};
}// namespace rspamd::composites
namespace rspamd::composites {
static constexpr const double epsilon = 0.00001;
struct symbol_remove_data {
const char *sym;
struct rspamd_composite *comp;
GNode *parent;
std::uint8_t action;
};
struct composites_data {
struct rspamd_task *task;
struct rspamd_composite *composite;
struct rspamd_scan_result *metric_res;
ankerl::unordered_dense::map<std::string_view,
std::vector<symbol_remove_data>>
symbols_to_remove;
std::vector<bool> checked;
explicit composites_data(struct rspamd_task *task, struct rspamd_scan_result *mres)
: task(task), composite(nullptr), metric_res(mres)
{
checked.resize(rspamd_composites_manager_nelts(task->cfg->composites_manager) * 2,
false);
}
};
struct rspamd_composite_option_match {
rspamd_regexp_t *re;
std::string match;
explicit rspamd_composite_option_match(const char *start, std::size_t len) noexcept
: re(nullptr), match(start, len)
{
}
explicit rspamd_composite_option_match(rspamd_regexp_t *re) noexcept
: re(rspamd_regexp_ref(re))
{
}
rspamd_composite_option_match(const rspamd_composite_option_match &other) noexcept
{
if (other.re) {
re = rspamd_regexp_ref(other.re);
}
else {
match = other.match;
re = nullptr;
}
}
rspamd_composite_option_match &operator=(const rspamd_composite_option_match &other) noexcept
{
if (other.re) {
if (re) {
rspamd_regexp_unref(re);
}
re = rspamd_regexp_ref(other.re);
}
else {
if (re) {
rspamd_regexp_unref(re);
}
re = nullptr;
match = other.match;
}
return *this;
}
rspamd_composite_option_match(rspamd_composite_option_match &&other) noexcept
{
if (other.re) {
re = other.re;
other.re = nullptr;
}
else {
re = nullptr;
match = std::move(other.match);
}
}
rspamd_composite_option_match &operator=(rspamd_composite_option_match &&other) noexcept
{
if (other.re) {
if (re) {
rspamd_regexp_unref(re);
}
re = other.re;
other.re = nullptr;
}
else {
if (re) {
rspamd_regexp_unref(re);
}
re = nullptr;
match = std::move(other.match);
}
return *this;
}
~rspamd_composite_option_match()
{
if (re) {
rspamd_regexp_unref(re);
}
}
auto match_opt(const std::string_view &data) const -> bool
{
if (re) {
return rspamd_regexp_search(re,
data.data(), data.size(),
nullptr, nullptr, false, nullptr);
}
else {
return data == match;
}
}
auto get_pat() const -> std::string_view
{
if (re) {
return std::string_view(rspamd_regexp_get_pattern(re));
}
else {
return match;
}
}
};
enum class rspamd_composite_atom_type {
ATOM_UNKNOWN,
ATOM_COMPOSITE,
ATOM_PLAIN
};
struct rspamd_composite_atom {
std::string symbol;
std::string_view norm_symbol;
rspamd_composite_atom_type comp_type = rspamd_composite_atom_type::ATOM_UNKNOWN;
const struct rspamd_composite *ncomp; /* underlying composite */
std::vector<rspamd_composite_option_match> opts;
};
enum rspamd_composite_action : std::uint8_t {
RSPAMD_COMPOSITE_UNTOUCH = 0,
RSPAMD_COMPOSITE_REMOVE_SYMBOL = (1u << 0),
RSPAMD_COMPOSITE_REMOVE_WEIGHT = (1u << 1),
RSPAMD_COMPOSITE_REMOVE_FORCED = (1u << 2)
};
static GQuark
rspamd_composites_quark(void)
{
return g_quark_from_static_string("composites");
}
static auto
rspamd_composite_atom_dtor(void *ptr)
{
auto *atom = reinterpret_cast<rspamd_composite_atom *>(ptr);
delete atom;
}
static rspamd_expression_atom_t *
rspamd_composite_expr_parse(const gchar *line, gsize len,
rspamd_mempool_t *pool,
gpointer ud, GError **err)
{
gsize clen = 0;
const gchar *p, *end;
enum composite_expr_state {
comp_state_read_symbol = 0,
comp_state_read_obrace,
comp_state_read_option,
comp_state_read_regexp,
comp_state_read_regexp_end,
comp_state_read_comma,
comp_state_read_ebrace,
comp_state_read_end
} state = comp_state_read_symbol;
end = line + len;
p = line;
/* Find length of the atom using a reduced state machine */
while (p < end) {
if (state == comp_state_read_end) {
break;
}
switch (state) {
case comp_state_read_symbol:
clen = rspamd_memcspn(p, "[; \t()><!|&\n", len);
p += clen;
if (*p == '[') {
state = comp_state_read_obrace;
}
else {
state = comp_state_read_end;
}
break;
case comp_state_read_obrace:
p++;
if (*p == '/') {
p++;
state = comp_state_read_regexp;
}
else {
state = comp_state_read_option;
}
break;
case comp_state_read_regexp:
if (*p == '\\' && p + 1 < end) {
/* Escaping */
p++;
}
else if (*p == '/') {
/* End of regexp, possible flags */
state = comp_state_read_regexp_end;
}
p++;
break;
case comp_state_read_option:
case comp_state_read_regexp_end:
if (*p == ',') {
p++;
state = comp_state_read_comma;
}
else if (*p == ']') {
state = comp_state_read_ebrace;
}
else {
p++;
}
break;
case comp_state_read_comma:
if (!g_ascii_isspace(*p)) {
if (*p == '/') {
state = comp_state_read_regexp;
}
else if (*p == ']') {
state = comp_state_read_ebrace;
}
else {
state = comp_state_read_option;
}
}
else {
/* Skip spaces after comma */
p++;
}
break;
case comp_state_read_ebrace:
p++;
state = comp_state_read_end;
break;
case comp_state_read_end:
g_assert_not_reached();
}
}
if (state != comp_state_read_end) {
g_set_error(err, rspamd_composites_quark(), 100, "invalid composite: %s;"
"parser stopped in state %d",
line, state);
return NULL;
}
clen = p - line;
p = line;
state = comp_state_read_symbol;
auto *atom = new rspamd_composite_atom;
auto *res = rspamd_mempool_alloc0_type(pool, rspamd_expression_atom_t);
res->len = clen;
res->str = line;
/* Full state machine to fill a composite atom */
const gchar *opt_start = nullptr;
while (p < end) {
if (state == comp_state_read_end) {
break;
}
switch (state) {
case comp_state_read_symbol: {
clen = rspamd_memcspn(p, "[; \t()><!|&\n", len);
p += clen;
if (*p == '[') {
state = comp_state_read_obrace;
}
else {
state = comp_state_read_end;
}
atom->symbol = std::string{line, clen};
auto norm_start = std::find_if(atom->symbol.begin(), atom->symbol.end(),
[](char c) { return g_ascii_isalnum(c); });
if (norm_start == atom->symbol.end()) {
msg_err_pool("invalid composite atom: %s", atom->symbol.c_str());
}
atom->norm_symbol = make_string_view_from_it(norm_start, atom->symbol.end());
break;
}
case comp_state_read_obrace:
p++;
if (*p == '/') {
opt_start = p;
p++; /* Starting slash */
state = comp_state_read_regexp;
}
else {
state = comp_state_read_option;
opt_start = p;
}
break;
case comp_state_read_regexp:
if (*p == '\\' && p + 1 < end) {
/* Escaping */
p++;
}
else if (*p == '/') {
/* End of regexp, possible flags */
state = comp_state_read_regexp_end;
}
p++;
break;
case comp_state_read_option:
if (*p == ',' || *p == ']') {
/* Plain match, copy option to ensure string_view validity */
gint opt_len = p - opt_start;
auto *opt_buf = rspamd_mempool_alloc_buffer(pool, opt_len + 1);
rspamd_strlcpy(opt_buf, opt_start, opt_len + 1);
opt_buf = g_strstrip(opt_buf);
atom->opts.emplace_back(opt_buf, strlen(opt_buf));
if (*p == ',') {
p++;
state = comp_state_read_comma;
}
else {
state = comp_state_read_ebrace;
}
}
else {
p++;
}
break;
case comp_state_read_regexp_end:
if (*p == ',' || *p == ']') {
auto opt_len = p - opt_start;
rspamd_regexp_t *re;
GError *re_err = nullptr;
re = rspamd_regexp_new_len(opt_start, opt_len, nullptr, &re_err);
if (re == nullptr) {
msg_err_pool("cannot create regexp from string %*s: %e",
opt_len, opt_start, re_err);
g_error_free(re_err);
}
else {
atom->opts.emplace_back(re);
rspamd_regexp_unref(re);
}
if (*p == ',') {
p++;
state = comp_state_read_comma;
}
else {
state = comp_state_read_ebrace;
}
}
else {
p++;
}
break;
case comp_state_read_comma:
if (!g_ascii_isspace(*p)) {
if (*p == '/') {
state = comp_state_read_regexp;
opt_start = p;
}
else if (*p == ']') {
state = comp_state_read_ebrace;
}
else {
opt_start = p;
state = comp_state_read_option;
}
}
else {
/* Skip spaces after comma */
p++;
}
break;
case comp_state_read_ebrace:
p++;
state = comp_state_read_end;
break;
case comp_state_read_end:
g_assert_not_reached();
}
}
res->data = atom;
return res;
}
static auto
process_symbol_removal(rspamd_expression_atom_t *atom,
struct composites_data *cd,
struct rspamd_symbol_result *ms,
const std::string &beg) -> void
{
struct rspamd_task *task = cd->task;
if (ms == nullptr) {
return;
}
/*
* At this point we know that we need to do something about this symbol,
* however, we don't know whether we need to delete it unfortunately,
* that depends on the later decisions when the complete expression is
* evaluated.
*/
auto rd_it = cd->symbols_to_remove.find(ms->name);
auto fill_removal_structure = [&](symbol_remove_data &nrd) {
nrd.sym = ms->name;
/* By default remove symbols */
switch (cd->composite->policy) {
case rspamd_composite_policy::RSPAMD_COMPOSITE_POLICY_REMOVE_ALL:
default:
nrd.action = (RSPAMD_COMPOSITE_REMOVE_SYMBOL | RSPAMD_COMPOSITE_REMOVE_WEIGHT);
break;
case rspamd_composite_policy::RSPAMD_COMPOSITE_POLICY_REMOVE_SYMBOL:
nrd.action = RSPAMD_COMPOSITE_REMOVE_SYMBOL;
break;
case rspamd_composite_policy::RSPAMD_COMPOSITE_POLICY_REMOVE_WEIGHT:
nrd.action = RSPAMD_COMPOSITE_REMOVE_WEIGHT;
break;
case rspamd_composite_policy::RSPAMD_COMPOSITE_POLICY_LEAVE:
nrd.action = 0;
break;
}
for (auto t: beg) {
if (t == '~') {
nrd.action &= ~RSPAMD_COMPOSITE_REMOVE_SYMBOL;
}
else if (t == '-') {
nrd.action &= ~(RSPAMD_COMPOSITE_REMOVE_WEIGHT |
RSPAMD_COMPOSITE_REMOVE_SYMBOL);
}
else if (t == '^') {
nrd.action |= RSPAMD_COMPOSITE_REMOVE_FORCED;
}
else {
break;
}
}
nrd.comp = cd->composite;
nrd.parent = atom->parent;
};
if (rd_it != cd->symbols_to_remove.end()) {
fill_removal_structure(rd_it->second.emplace_back());
msg_debug_composites("%s: added symbol %s to removal: %d policy, from composite %s",
cd->metric_res->name,
ms->name, rd_it->second.back().action,
cd->composite->sym.c_str());
}
else {
std::vector<symbol_remove_data> nrd;
fill_removal_structure(nrd.emplace_back());
msg_debug_composites("%s: added symbol %s to removal: %d policy, from composite %s",
cd->metric_res->name,
ms->name, nrd.front().action,
cd->composite->sym.c_str());
cd->symbols_to_remove[ms->name] = std::move(nrd);
}
}
static auto
process_single_symbol(struct composites_data *cd,
std::string_view sym,
struct rspamd_symbol_result **pms,
struct rspamd_composite_atom *atom) -> double
{
struct rspamd_symbol_result *ms = nullptr;
gdouble rc = 0;
struct rspamd_task *task = cd->task;
if ((ms = rspamd_task_find_symbol_result(cd->task, sym.data(), cd->metric_res)) == nullptr) {
msg_debug_composites("not found symbol %s in composite %s", sym.data(),
cd->composite->sym.c_str());
if (G_UNLIKELY(atom->comp_type == rspamd_composite_atom_type::ATOM_UNKNOWN)) {
const struct rspamd_composite *ncomp;
if ((ncomp = COMPOSITE_MANAGER_FROM_PTR(task->cfg->composites_manager)->find(sym)) != NULL) {
atom->comp_type = rspamd_composite_atom_type::ATOM_COMPOSITE;
atom->ncomp = ncomp;
}
else {
atom->comp_type = rspamd_composite_atom_type::ATOM_PLAIN;
}
}
if (atom->comp_type == rspamd_composite_atom_type::ATOM_COMPOSITE) {
msg_debug_composites("symbol %s for composite %s is another composite",
sym.data(), cd->composite->sym.c_str());
if (!cd->checked[atom->ncomp->id * 2]) {
msg_debug_composites("composite dependency %s for %s is not checked",
sym.data(), cd->composite->sym.c_str());
/* Set checked for this symbol to avoid cyclic references */
cd->checked[cd->composite->id * 2] = true;
auto *saved = cd->composite; /* Save the current composite */
composites_foreach_callback((gpointer) atom->ncomp->sym.c_str(),
(gpointer) atom->ncomp, (gpointer) cd);
/* Restore state */
cd->composite = saved;
cd->checked[cd->composite->id * 2] = false;
ms = rspamd_task_find_symbol_result(cd->task, sym.data(),
cd->metric_res);
}
else {
/*
* XXX: in case of cyclic references this would return 0
*/
if (cd->checked[atom->ncomp->id * 2 + 1]) {
ms = rspamd_task_find_symbol_result(cd->task, sym.data(),
cd->metric_res);
}
}
}
}
if (ms) {
msg_debug_composites("found symbol %s in composite %s, weight: %.3f",
sym.data(), cd->composite->sym.c_str(), ms->score);
/* Now check options */
for (const auto &cur_opt: atom->opts) {
struct rspamd_symbol_option *opt;
auto found = false;
DL_FOREACH(ms->opts_head, opt)
{
if (cur_opt.match_opt({opt->option, opt->optlen})) {
found = true;
break;
}
}
if (!found) {
auto pat = cur_opt.get_pat();
msg_debug_composites("symbol %s in composite %s misses required option %*s",
sym.data(),
cd->composite->sym.c_str(),
(int) pat.size(), pat.data());
ms = nullptr;
break;
}
}
if (ms) {
if (ms->score == 0) {
rc = epsilon * 16.0; /* Distinguish from 0 */
}
else {
rc = ms->score;
}
}
}
*pms = ms;
return rc;
}
static auto
rspamd_composite_expr_process(void *ud, rspamd_expression_atom_t *atom) -> double
{
struct composites_data *cd = (struct composites_data *) ud;
struct rspamd_composite_atom *comp_atom = (struct rspamd_composite_atom *) atom->data;
struct rspamd_symbol_result *ms = NULL;
struct rspamd_task *task = cd->task;
gdouble rc = 0;
if (cd->checked[cd->composite->id * 2]) {
/* We have already checked this composite, so just return its value */
if (cd->checked[cd->composite->id * 2 + 1]) {
ms = rspamd_task_find_symbol_result(cd->task,
comp_atom->norm_symbol.data(),
cd->metric_res);
}
if (ms) {
if (ms->score == 0) {
rc = epsilon; /* Distinguish from 0 */
}
else {
/* Treat negative and positive scores equally... */
rc = fabs(ms->score);
}
}
msg_debug_composites("composite %s is already checked, result: %.2f",
cd->composite->sym.c_str(), rc);
return rc;
}
/* Note: sym is zero terminated as it is a view on std::string */
auto sym = comp_atom->norm_symbol;
auto group_process_functor = [&](auto cond, int sub_start) -> double {
auto max = 0.;
GHashTableIter it;
gpointer k, v;
struct rspamd_symbols_group *gr;
gr = (struct rspamd_symbols_group *) g_hash_table_lookup(cd->task->cfg->groups,
sym.substr(sub_start).data());
if (gr != nullptr) {
g_hash_table_iter_init(&it, gr->symbols);
while (g_hash_table_iter_next(&it, &k, &v)) {
auto *sdef = (rspamd_symbol *) v;
if (cond(sdef->score)) {
rc = process_single_symbol(cd,
std::string_view(sdef->name),
&ms,
comp_atom);
if (fabs(rc) > epsilon) {
process_symbol_removal(atom,
cd,
ms,
comp_atom->symbol);
if (fabs(rc) > max) {
max = fabs(rc);
}
}
}
}
}
return max;
};
if (sym.size() > 2) {
if (sym.substr(0, 2) == "g:") {
rc = group_process_functor([](auto _) { return true; }, 2);
}
else if (sym.substr(0, 3) == "g+:") {
/* Group, positive symbols only */
rc = group_process_functor([](auto sc) { return sc > 0.; }, 3);
}
else if (sym.substr(0, 3) == "g-:") {
rc = group_process_functor([](auto sc) { return sc < 0.; }, 3);
}
else {
rc = process_single_symbol(cd, sym, &ms, comp_atom);
if (fabs(rc) > epsilon) {
process_symbol_removal(atom,
cd,
ms,
comp_atom->symbol);
}
}
}
else {
rc = process_single_symbol(cd, sym, &ms, comp_atom);
if (fabs(rc) > epsilon) {
process_symbol_removal(atom,
cd,
ms,
comp_atom->symbol);
}
}
msg_debug_composites("%s: result for atom %s in composite %s is %.4f",
cd->metric_res->name,
comp_atom->norm_symbol.data(),
cd->composite->sym.c_str(), rc);
return rc;
}
/*
* We don't have preferences for composites
*/
static gint
rspamd_composite_expr_priority(rspamd_expression_atom_t *atom)
{
return 0;
}
static void
rspamd_composite_expr_destroy(rspamd_expression_atom_t *atom)
{
rspamd_composite_atom_dtor(atom->data);
}
static void
composites_foreach_callback(gpointer key, gpointer value, void *data)
{
auto *cd = (struct composites_data *) data;
auto *comp = (struct rspamd_composite *) value;
auto *str_key = (const gchar *) key;
struct rspamd_task *task;
gdouble rc;
cd->composite = comp;
task = cd->task;
msg_debug_composites("process composite %s", str_key);
if (!cd->checked[cd->composite->id * 2]) {
if (rspamd_symcache_is_checked(cd->task, cd->task->cfg->cache,
str_key)) {
msg_debug_composites("composite %s is checked in symcache but not "
"in composites bitfield",
cd->composite->sym.c_str());
cd->checked[comp->id * 2] = true;
cd->checked[comp->id * 2 + 1] = false;
}
else {
if (rspamd_task_find_symbol_result(cd->task, str_key,
cd->metric_res) != nullptr) {
/* Already set, no need to check */
msg_debug_composites("composite %s is already in metric "
"in composites bitfield",
cd->composite->sym.c_str());
cd->checked[comp->id * 2] = true;
cd->checked[comp->id * 2 + 1] = true;
return;
}
msg_debug_composites("%s: start processing composite %s",
cd->metric_res->name,
cd->composite->sym.c_str());
rc = rspamd_process_expression(comp->expr, RSPAMD_EXPRESSION_FLAG_NOOPT,
cd);
/* Checked bit */
cd->checked[comp->id * 2] = true;
msg_debug_composites("%s: final result for composite %s is %.4f",
cd->metric_res->name,
cd->composite->sym.c_str(), rc);
/* Result bit */
if (fabs(rc) > epsilon) {
cd->checked[comp->id * 2 + 1] = true;
rspamd_task_insert_result_full(cd->task, str_key, 1.0, NULL,
RSPAMD_SYMBOL_INSERT_SINGLE, cd->metric_res);
}
else {
cd->checked[comp->id * 2 + 1] = false;
}
}
}
}
static auto
remove_symbols(const composites_data &cd, const std::vector<symbol_remove_data> &rd) -> void
{
struct rspamd_task *task = cd.task;
gboolean skip = FALSE,
has_valid_op = FALSE,
want_remove_score = TRUE,
want_remove_symbol = TRUE,
want_forced = FALSE;
const gchar *disable_score_reason = "no policy",
*disable_symbol_reason = "no policy";
task = cd.task;
for (const auto &cur: rd) {
if (!cd.checked[cur.comp->id * 2 + 1]) {
continue;
}
/*
* First of all exclude all elements with any parent that is negation:
* !A || B -> here we can have both !A and B matched, but we do *NOT*
* want to remove symbol in that case
*/
auto *par = cur.parent;
skip = FALSE;
while (par) {
if (rspamd_expression_node_is_op(par, OP_NOT)) {
skip = TRUE;
break;
}
par = par->parent;
}
if (skip) {
continue;
}
has_valid_op = TRUE;
/*
* Now we can try to remove symbols/scores
*
* We apply the following logic here:
* - if no composites would like to save score then we remove score
* - if no composites would like to save symbol then we remove symbol
*/
if (!want_forced) {
if (!(cur.action & RSPAMD_COMPOSITE_REMOVE_SYMBOL)) {
want_remove_symbol = FALSE;
disable_symbol_reason = cur.comp->sym.c_str();
}
if (!(cur.action & RSPAMD_COMPOSITE_REMOVE_WEIGHT)) {
want_remove_score = FALSE;
disable_score_reason = cur.comp->sym.c_str();
}
if (cur.action & RSPAMD_COMPOSITE_REMOVE_FORCED) {
want_forced = TRUE;
disable_symbol_reason = cur.comp->sym.c_str();
disable_score_reason = cur.comp->sym.c_str();
}
}
}
auto *ms = rspamd_task_find_symbol_result(task, rd.front().sym, cd.metric_res);
if (has_valid_op && ms && !(ms->flags & RSPAMD_SYMBOL_RESULT_IGNORED)) {
if (want_remove_score || want_forced) {
msg_debug_composites("%s: %s remove symbol weight for %s (was %.2f), "
"score removal affected by %s, symbol removal affected by %s",
cd.metric_res->name,
(want_forced ? "forced" : "normal"), rd.front().sym, ms->score,
disable_score_reason, disable_symbol_reason);
cd.metric_res->score -= ms->score;
ms->score = 0.0;
}
if (want_remove_symbol || want_forced) {
ms->flags |= RSPAMD_SYMBOL_RESULT_IGNORED;
msg_debug_composites("%s: %s remove symbol %s (score %.2f), "
"score removal affected by %s, symbol removal affected by %s",
cd.metric_res->name,
(want_forced ? "forced" : "normal"), rd.front().sym, ms->score,
disable_score_reason, disable_symbol_reason);
}
}
}
static void
composites_metric_callback(struct rspamd_task *task)
{
std::vector<composites_data> comp_data_vec;
struct rspamd_scan_result *mres;
comp_data_vec.reserve(1);
DL_FOREACH(task->result, mres)
{
auto &cd = comp_data_vec.emplace_back(task, mres);
/* Process metric result */
rspamd_symcache_composites_foreach(task,
task->cfg->cache,
composites_foreach_callback,
&cd);
}
for (const auto &cd: comp_data_vec) {
/* Remove symbols that are in composites */
for (const auto &srd_it: cd.symbols_to_remove) {
remove_symbols(cd, srd_it.second);
}
}
}
}// namespace rspamd::composites
void rspamd_composites_process_task(struct rspamd_task *task)
{
if (task->result && !RSPAMD_TASK_IS_SKIPPED(task)) {
rspamd::composites::composites_metric_callback(task);
}
}
|