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
|
--[[
Copyright (c) 2016, Vsevolod Stakhov <vsevolod@highsecure.ru>
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.
]]--
-- This plugin is a concept of FANN scores adjustment
-- NOT FOR PRODUCTION USE so far
local rspamd_logger = require "rspamd_logger"
local rspamd_fann = require "rspamd_fann"
local rspamd_util = require "rspamd_util"
local fann_symbol_spam = 'FANNR_SPAM'
local fann_symbol_ham = 'FANNR_HAM'
local fun = require "fun"
local module_log_id = 0x200
-- Module vars
-- ANNs indexed by settings id
local fanns = {
['0'] = {
version = 0,
}
}
-- Lua script to train a row
-- Uses the following keys:
-- key1 - prefix for fann
-- key2 - fann suffix (settings id)
-- key3 - spam or ham
-- returns 1 or 0: 1 - allow learn, 0 - not allow learn
local redis_lua_script_can_train = [[
local prefix = KEYS[1] .. KEYS[2]
local locked = redis.call('GET', prefix .. '_locked')
if locked then return 0 end
local nspam = 0
local nham = 0
local exists = redis.call('SISMEMBER', KEYS[1], KEYS[2])
if not exists or exists == 0 then
redis.call('SADD', KEYS[1], KEYS[2])
end
local ret = redis.call('LLEN', prefix .. '_spam')
if ret then nspam = tonumber(ret) end
ret = redis.call('LLEN', prefix .. '_ham')
if ret then nham = tonumber(ret) end
if KEYS[3] == 'spam' then
if nham + 1 >= nspam then return tostring(nspam + 1) end
else
if nspam + 1 >= nham then return tostring(nham + 1) end
end
return tostring(0)
]]
local redis_can_train_sha = nil
-- Lua script to load ANN from redis
-- Uses the following keys
-- key1 - prefix for keys
-- key2 - local version
-- returns nil or bulk string if new ANN can be loaded
local redis_lua_script_maybe_load = [[
local locked = redis.call('GET', KEYS[1] .. '_locked')
if locked then return false end
local ver = 0
local ret = redis.call('GET', KEYS[1] .. '_version')
if ret then ver = tonumber(ret) end
if ver > tonumber(KEYS[2]) then
return {redis.call('GET', KEYS[1] .. '_data'), ret}
end
return false
]]
local redis_maybe_load_sha = nil
-- Lua script to invalidate ANN from redis
-- Uses the following keys
-- key1 - prefix for keys
local redis_lua_script_maybe_invalidate = [[
local locked = redis.call('GET', KEYS[1] .. '_locked')
if locked then return false end
redis.call('SET', KEYS[1] .. '_locked', '1')
redis.call('SET', KEYS[1] .. '_version', '0')
redis.call('DEL', KEYS[1] .. '_spam')
redis.call('DEL', KEYS[1] .. '_ham')
redis.call('DEL', KEYS[1] .. '_data')
redis.call('DEL', KEYS[1] .. '_locked')
return 1
]]
local redis_maybe_invalidate_sha = nil
-- Lua script to invalidate ANN from redis
-- Uses the following keys
-- key1 - prefix for keys
-- key2 - current time
-- key3 - key expire
local redis_lua_script_maybe_lock = [[
local locked = redis.call('GET', KEYS[1] .. '_locked')
if locked then
if tonumber(KEYS[2]) < tonumber(locked) then
return false
end
end
redis.call('SET', KEYS[1] .. '_locked', tostring(tonumber(KEYS[2]) + tonumber(KEYS[3])))
return 1
]]
local redis_maybe_lock_sha = nil
-- Lua script to save and unlock ANN in redis
-- Uses the following keys
-- key1 - prefix for keys
-- key2 - compressed ANN
local redis_lua_script_save_unlock = [[
redis.call('INCRBY', KEYS[1] .. '_version', '1')
redis.call('DEL', KEYS[1] .. '_spam')
redis.call('DEL', KEYS[1] .. '_ham')
redis.call('SET', KEYS[1] .. '_data', KEYS[2])
redis.call('DEL', KEYS[1] .. '_locked')
return 1
]]
local redis_save_unlock_sha = nil
local redis_params
redis_params = rspamd_parse_redis_server('fann_redis')
local fann_prefix = 'RFANN'
local max_trains = 1000
local max_epoch = 1000
local max_usages = 10
local use_settings = false
local watch_interval = 60.0
local mse = 0.0001
local nlayers = 4
local lock_expire = 600
local learning_spawned = false
local function redis_make_request(ev_base, cfg, key, is_write, callback, command, args)
if not ev_base or not redis_params or not callback or not command then
return false,nil,nil
end
local addr
local rspamd_redis = require "rspamd_redis"
if key then
if is_write then
addr = redis_params['write_servers']:get_upstream_by_hash(key)
else
addr = redis_params['read_servers']:get_upstream_by_hash(key)
end
else
if is_write then
addr = redis_params['write_servers']:get_upstream_master_slave(key)
else
addr = redis_params['read_servers']:get_upstream_round_robin(key)
end
end
if not addr then
rspamd_logger.errx(cfg, 'cannot select server to make redis request')
end
local options = {
ev_base = ev_base,
config = cfg,
callback = callback,
host = addr:get_addr(),
timeout = redis_params['timeout'],
cmd = command,
args = args
}
if redis_params['password'] then
options['password'] = redis_params['password']
end
if redis_params['db'] then
options['dbname'] = redis_params['db']
end
local ret,conn = rspamd_redis.make_request(options)
if not ret then
rspamd_logger.errx('cannot execute redis request')
end
return ret,conn,addr
end
local function symbols_to_fann_vector(syms, scores)
local learn_data = {}
local matched_symbols = {}
local n = rspamd_config:get_symbols_count()
fun.each(function(s, score)
matched_symbols[s + 1] = rspamd_util.tanh(score)
end, fun.zip(syms, scores))
for i=1,n do
if matched_symbols[i] then
learn_data[i] = matched_symbols[i]
else
learn_data[i] = 0
end
end
return learn_data
end
local function gen_fann_prefix(id)
return fann_prefix .. id,id
end
local function is_fann_valid(ann)
if ann then
local n = rspamd_config:get_symbols_count() + rspamd_count_metatokens()
if n ~= ann:get_inputs() then
rspamd_logger.infox(rspamd_config, 'fann has incorrect number of inputs: %s, %s symbols' ..
' is found in the cache', ann:get_inputs(), n)
return false
end
local layers = ann:get_layers()
if not layers or #layers ~= nlayers then
rspamd_logger.infox(rspamd_config, 'fann has incorrect number of layers: %s',
#layers)
return false
end
return true
end
end
local function fann_scores_filter(task)
local id = '0'
if use_settings then
local sid = task:get_settings_id()
if sid then
id = tostring(sid)
end
end
if fanns[id].fann then
local symbols,scores = task:get_symbols_numeric()
local fann_data = symbols_to_fann_vector(symbols, scores)
local mt = rspamd_gen_metatokens(task)
for _,tok in ipairs(mt) do
table.insert(fann_data, tok)
end
local out = fanns[id].fann:test(fann_data)
local symscore = string.format('%.3f', out[1])
rspamd_logger.infox(task, 'fann score: %s', symscore)
if out[1] > 0 then
local result = rspamd_util.normalize_prob(out[1] / 2.0, 0)
task:insert_result(fann_symbol_spam, result, symscore, id)
else
local result = rspamd_util.normalize_prob((-out[1]) / 2.0, 0)
task:insert_result(fann_symbol_ham, result, symscore, id)
end
end
end
local function create_train_fann(n, id)
id = tostring(id)
if not fanns[id] then
fanns[id] = {}
end
if fanns[id].fann then
if fanns[id].version % max_usages == 0 then
-- Forget last fann
rspamd_logger.infox(rspamd_config, 'recreate ANN %s, version %s', id,
fanns[id].version)
fanns[id].fann_train = rspamd_fann.create(nlayers, n, n / 2, n / 4, 1)
fanns[id].fann = nil
else
fanns[id].fann_train = fanns[id].fann
fanns[id].fann = nil
end
else
fanns[id].fann_train = rspamd_fann.create(nlayers, n, n / 2, n / 4, 1)
fanns[id].version = 0
end
end
local function load_or_invalidate_fann(data, id, ev_base)
local ver = data[2]
if not ver or not tonumber(ver) then
rspamd_logger.errx(rspamd_config, 'cannot get version for ann: %s', id)
return
end
local err,ann_data = rspamd_util.zstd_decompress(data[1])
local ann
if err or not ann_data then
rspamd_logger.errx(rspamd_config, 'cannot decompress ann %s: %s', id, err)
return
else
ann = rspamd_fann.load_data(ann_data)
end
if is_fann_valid(ann) then
fanns[id].fann = ann
rspamd_logger.infox(rspamd_config, 'loaded ann %s version %s from redis',
id, ver)
fanns[id].version = tonumber(ver)
else
local function redis_invalidate_cb(_err, _data)
if _err then
rspamd_logger.errx(rspamd_config, 'cannot invalidate ANN %s from redis: %s', id, _err)
elseif type(_data) == 'string' then
rspamd_logger.infox(rspamd_config, 'invalidated ANN %s from redis: %s', id, _err)
fanns[id].version = 0
end
end
-- Invalidate ANN
rspamd_logger.infox('invalidate ANN %s')
redis_make_request(ev_base,
rspamd_config,
nil,
true, -- is write
redis_invalidate_cb, --callback
'EVALSHA', -- command
{redis_maybe_invalidate_sha, 1, gen_fann_prefix(id)}
)
end
end
local function fann_train_callback(score, required_score, results, _, id, opts, extra, ev_base)
local fname,suffix = gen_fann_prefix(id)
local learn_spam, learn_ham
if opts['spam_score'] then
learn_spam = score >= opts['spam_score']
else
learn_spam = score >= required_score
end
if opts['ham_score'] then
learn_ham = score <= opts['ham_score']
else
learn_ham = score < 0
end
if learn_spam or learn_ham then
local k
if learn_spam then k = 'spam' else k = 'ham' end
local function learn_vec_cb(err)
if err then
rspamd_logger.errx(rspamd_config, 'cannot store train vector: %s', err)
end
end
local function can_train_cb(err, data)
if not err and tonumber(data) > 0 then
local learn_data = symbols_to_fann_vector(
fun.map(function(r) return r[1] end, results),
fun.map(function(r) return r[2] end, results)
)
-- Add filtered meta tokens
fun.each(function(e) table.insert(learn_data, e) end, extra)
local str = rspamd_util.zstd_compress(table.concat(learn_data, ';'))
redis_make_request(ev_base,
rspamd_config,
nil,
true, -- is write
learn_vec_cb, --callback
'LPUSH', -- command
{fname .. '_' .. k, str} -- arguments
)
else
if err then
rspamd_logger.errx(rspamd_config, 'cannot check if we can train: %s', err)
end
end
end
redis_make_request(ev_base,
rspamd_config,
nil,
true, -- is write
can_train_cb, --callback
'EVALSHA', -- command
{redis_can_train_sha, '3', fann_prefix, suffix, k} -- arguments
)
end
end
local function train_fann(_, ev_base, elt)
local spam_elts = {}
local ham_elts = {}
elt = tostring(elt)
local function redis_unlock_cb(err)
if err then
rspamd_logger.errx(rspamd_config, 'cannot unlock ANN %s from redis: %s',
fann_prefix .. elt, err)
end
end
local function redis_save_cb(err)
if err then
rspamd_logger.errx(rspamd_config, 'cannot save ANN %s to redis: %s',
fann_prefix .. elt, err)
redis_make_request(ev_base,
rspamd_config,
nil,
false, -- is write
redis_unlock_cb, --callback
'DEL', -- command
{fann_prefix .. elt .. '_lock'}
)
end
end
local function ann_trained(errcode, errmsg, train_mse)
learning_spawned = false
if errcode ~= 0 then
rspamd_logger.errx(rspamd_config, 'cannot train ANN %s: %s',
fann_prefix .. elt, errmsg)
redis_make_request(ev_base,
rspamd_config,
nil,
false, -- is write
redis_unlock_cb, --callback
'DEL', -- command
{fann_prefix .. elt .. '_lock'}
)
else
rspamd_logger.infox(rspamd_config, 'trained ANN %s: MSE: %s',
fann_prefix .. elt, train_mse)
local ann_data = rspamd_util.zstd_compress(fanns[elt].fann_train:data())
fanns[elt].version = fanns[elt].version + 1
fanns[elt].fann = fanns[elt].fann_train
fanns[elt].fann_train = nil
redis_make_request(ev_base,
rspamd_config,
nil,
true, -- is write
redis_save_cb, --callback
'EVALSHA', -- command
{redis_save_unlock_sha, '2', fann_prefix .. elt, ann_data}
)
end
end
local function redis_ham_cb(err, data)
if err or type(data) ~= 'table' then
rspamd_logger.errx(rspamd_config, 'cannot get ham tokens for ANN %s from redis: %s',
fann_prefix .. elt, err)
redis_make_request(ev_base,
rspamd_config,
nil,
false, -- is write
redis_unlock_cb, --callback
'DEL', -- command
{fann_prefix .. elt .. '_lock'}
)
else
-- Decompress and convert to numbers each training vector
ham_elts = fun.map(function(tok)
local _,str = rspamd_util.zstd_decompress(tok)
return fun.map(tonumber, rspamd_str_split(tostring(str), ';'))
end, data)
-- Now we need to join inputs and create the appropriate test vectors
local inputs = {}
local outputs = {}
fun.each(function(spam_sample, ham_sample)
table.insert(inputs, fun.totable(spam_sample))
table.insert(outputs, {1.0})
table.insert(inputs, fun.totable(ham_sample))
table.insert(outputs, {-1.0})
end, fun.zip(spam_elts, ham_elts))
-- Now we can train fann
local n = rspamd_config:get_symbols_count() + rspamd_count_metatokens()
if not fanns[elt] or not fanns[elt].fann_train then
-- Create fann if it does not exist
create_train_fann(n, elt)
end
learning_spawned = true
rspamd_logger.infox(rspamd_config, 'start learning ANN %s', elt)
fanns[elt].fann_train:train_threaded(inputs, outputs, ann_trained, ev_base,
{max_epochs = max_epoch, desired_mse = mse})
end
end
local function redis_spam_cb(err, data)
if err or type(data) ~= 'table' then
rspamd_logger.errx(rspamd_config, 'cannot get spam tokens for ANN %s from redis: %s',
fann_prefix .. elt, err)
redis_make_request(ev_base,
rspamd_config,
nil,
false, -- is write
redis_unlock_cb, --callback
'DEL', -- command
{fann_prefix .. elt .. '_lock'}
)
else
-- Decompress and convert to numbers each training vector
spam_elts = fun.map(function(tok)
local _,str = rspamd_util.zstd_decompress(tok)
return fun.map(tonumber, rspamd_str_split(tostring(str), ';'))
end, data)
redis_make_request(ev_base,
rspamd_config,
nil,
false, -- is write
redis_ham_cb, --callback
'LRANGE', -- command
{fann_prefix .. elt .. '_ham', '0', '-1'}
)
end
end
local function redis_lock_cb(err, data)
if err then
rspamd_logger.errx(rspamd_config, 'cannot lock ANN %s from redis: %s',
fann_prefix .. elt, err)
elseif type(data) == 'number' then
-- Can train ANN
redis_make_request(ev_base,
rspamd_config,
nil,
false, -- is write
redis_spam_cb, --callback
'LRANGE', -- command
{fann_prefix .. elt .. '_spam', '0', '-1'}
)
rspamd_logger.infox(rspamd_config, 'lock ANN %s for learning', elt)
else
rspamd_logger.infox(rspamd_config, 'do not learn ANN %s, locked by another process', elt)
end
end
if learning_spawned then
rspamd_logger.infox(rspamd_config, 'do not learn ANN %s, already learning another ANN')
return
end
redis_make_request(ev_base,
rspamd_config,
nil,
true, -- is write
redis_lock_cb, --callback
'EVALSHA', -- command
{redis_maybe_lock_sha, '3', fann_prefix .. elt, tostring(os.time()),
tostring(lock_expire)}
)
end
local function maybe_train_fanns(cfg, ev_base)
local function members_cb(err, data)
if err then
rspamd_logger.errx(rspamd_config, 'cannot get FANNS list from redis: %s', err)
elseif type(data) == 'table' then
fun.each(function(elt)
elt = tostring(elt)
local redis_len_cb = function(_err, _data)
if _err then
rspamd_logger.errx(rspamd_config, 'cannot get FANN trains %s from redis: %s', elt, _err)
elseif _data and type(_data) == 'number' or type(_data) == 'string' then
if tonumber(_data) and tonumber(_data) > max_trains then
rspamd_logger.infox(rspamd_config, 'need to learn ANN %s after %s learn vectors (%s required)',
elt, tonumber(_data), max_trains)
train_fann(cfg, ev_base, elt)
end
end
end
redis_make_request(ev_base,
rspamd_config,
nil,
false, -- is write
redis_len_cb, --callback
'LLEN', -- command
{fann_prefix .. elt .. '_spam'}
)
end,
data)
end
end
if not redis_maybe_load_sha then
-- Plan new event early
return 1.0
end
-- First we need to get all fanns stored in our Redis
redis_make_request(ev_base,
rspamd_config,
nil,
false, -- is write
members_cb, --callback
'SMEMBERS', -- command
{fann_prefix} -- arguments
)
return watch_interval
end
local function load_scripts(cfg, ev_base, on_load_cb)
local function can_train_sha_cb(err, data)
if err or not data or type(data) ~= 'string' then
rspamd_logger.errx(cfg, 'cannot save redis train script: %s', err)
else
redis_can_train_sha = tostring(data)
end
end
redis_make_request(ev_base,
rspamd_config,
nil,
true, -- is write
can_train_sha_cb, --callback
'SCRIPT', -- command
{'LOAD', redis_lua_script_can_train} -- arguments
)
local function maybe_load_sha_cb(err, data)
if err or not data or type(data) ~= 'string' then
rspamd_logger.errx(cfg, 'cannot save redis load script: %s', err)
else
redis_maybe_load_sha = tostring(data)
if on_load_cb then
rspamd_config:add_periodic(ev_base, 0.0,
function(_cfg, _ev_base)
return on_load_cb(_cfg, _ev_base)
end)
end
end
end
redis_make_request(ev_base,
rspamd_config,
nil,
true, -- is write
maybe_load_sha_cb, --callback
'SCRIPT', -- command
{'LOAD', redis_lua_script_maybe_load} -- arguments
)
local function maybe_invalidate_sha_cb(err, data)
if err or not data or type(data) ~= 'string' then
rspamd_logger.errx(cfg, 'cannot save redis invalidate script: %s', err)
else
redis_maybe_invalidate_sha = tostring(data)
end
end
redis_make_request(ev_base,
rspamd_config,
nil,
true, -- is write
maybe_invalidate_sha_cb, --callback
'SCRIPT', -- command
{'LOAD', redis_lua_script_maybe_invalidate} -- arguments
)
local function maybe_lock_sha_cb(err, data)
if err or not data or type(data) ~= 'string' then
rspamd_logger.errx(cfg, 'cannot save redis lock script: %s', err)
else
redis_maybe_lock_sha = tostring(data)
end
end
redis_make_request(ev_base,
rspamd_config,
nil,
true, -- is write
maybe_lock_sha_cb, --callback
'SCRIPT', -- command
{'LOAD', redis_lua_script_maybe_lock} -- arguments
)
local function save_unlock_sha_cb(err, data)
if err or not data or type(data) ~= 'string' then
rspamd_logger.errx(cfg, 'cannot save redis save script: %s', err)
else
redis_save_unlock_sha = tostring(data)
end
end
redis_make_request(ev_base,
rspamd_config,
nil,
true, -- is write
save_unlock_sha_cb, --callback
'SCRIPT', -- command
{'LOAD', redis_lua_script_save_unlock} -- arguments
)
end
local function check_fanns(_, ev_base)
local function members_cb(err, data)
if err then
rspamd_logger.errx(rspamd_config, 'cannot get FANNS list from redis: %s', err)
elseif type(data) == 'table' then
fun.each(function(elt)
elt = tostring(elt)
local redis_update_cb = function(_err, _data)
if _err then
rspamd_logger.errx(rspamd_config, 'cannot get FANN version %s from redis: %s', elt, _err)
if string.match(_err, 'NOSCRIPT') then
load_scripts(rspamd_config, ev_base, nil)
end
elseif _data and type(_data) == 'table' then
load_or_invalidate_fann(_data, elt, ev_base)
end
end
local local_ver = 0
if fanns[elt] then
if fanns[elt].version then
local_ver = fanns[elt].version
end
end
redis_make_request(ev_base,
rspamd_config,
nil,
false, -- is write
redis_update_cb, --callback
'EVALSHA', -- command
{redis_maybe_load_sha, 2, fann_prefix .. elt, tostring(local_ver)}
)
end,
data)
end
end
if not redis_maybe_load_sha then
-- Plan new event early
return 1.0
end
-- First we need to get all fanns stored in our Redis
redis_make_request(ev_base,
rspamd_config,
nil,
false, -- is write
members_cb, --callback
'SMEMBERS', -- command
{fann_prefix} -- arguments
)
return watch_interval
end
-- Initialization part
local opts = rspamd_config:get_all_opt("fann_redis")
if not (opts and type(opts) == 'table') or not redis_params then
rspamd_logger.infox(rspamd_config, 'Module is unconfigured')
return
end
if not rspamd_fann.is_enabled() then
rspamd_logger.errx(rspamd_config, 'fann is not compiled in rspamd, this ' ..
'module is eventually disabled')
return
else
use_settings = opts['use_settings']
if opts['spam_symbol'] then
fann_symbol_spam = opts['spam_symbol']
end
if opts['ham_symbol'] then
fann_symbol_ham = opts['ham_symbol']
end
rspamd_config:set_metric_symbol({
name = fann_symbol_spam,
score = 3.0,
description = 'Neural network SPAM',
group = 'fann'
})
local id = rspamd_config:register_symbol({
name = fann_symbol_spam,
type = 'postfilter',
priority = 5,
callback = fann_scores_filter
})
rspamd_config:set_metric_symbol({
name = fann_symbol_ham,
score = -2.0,
description = 'Neural network HAM',
group = 'fann'
})
rspamd_config:register_symbol({
name = fann_symbol_ham,
type = 'virtual',
parent = id
})
if opts['train'] then
rspamd_config:add_on_load(function(cfg)
if opts['train']['max_train'] then
max_trains = opts['train']['max_train']
end
if opts['train']['max_epoch'] then
max_epoch = opts['train']['max_epoch']
end
if opts['train']['max_usages'] then
max_usages = opts['train']['max_usages']
end
if opts['train']['mse'] then
mse = opts['train']['mse']
end
local ret = cfg:register_worker_script("log_helper",
function(score, req_score, results, cf, _id, extra, ev_base)
-- fun.map (snd x) (fun.filter (fst x == module_id) extra)
local extra_fann = fun.map(function(e) return e[2] end,
fun.filter(function(e) return e[1] == module_log_id end, extra))
if use_settings then
fann_train_callback(score, req_score, results, cf,
tostring(_id), opts['train'], extra_fann, ev_base)
else
fann_train_callback(score, req_score, results, cf, '0',
opts['train'], extra_fann, ev_base)
end
end)
if not ret then
rspamd_logger.errx(cfg, 'cannot find worker "log_helper"')
end
end)
-- This is needed to pass extra tokens from worker to log_helper
rspamd_plugins["fann_redis"] = {
log_callback = function(task)
return fun.totable(fun.map(
function(tok) return {module_log_id, tok} end,
rspamd_gen_metatokens(task)))
end
}
end
-- Add training scripts
rspamd_config:add_on_load(function(cfg, ev_base, worker)
load_scripts(cfg, ev_base, check_fanns)
if worker:get_name() == 'normal' then
-- We also want to train neural nets when they have enough data
rspamd_config:add_periodic(ev_base, 0.0,
function(_cfg, _ev_base)
return maybe_train_fanns(_cfg, _ev_base)
end)
end
end)
end
|