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
990
991
992
993
994
995
996
997
998
999
1000
|
--[[
Copyright (c) 2017, 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.
]]--
local logger = require "rspamd_logger"
local lutil = require "lua_util"
local rspamd_util = require "rspamd_util"
local exports = {}
local E = {}
--[[[
-- @module lua_redis
-- This module contains helper functions for working with Redis
--]]
local function try_load_redis_servers(options, rspamd_config, result)
local default_port = 6379
local default_timeout = 1.0
local default_expand_keys = false
local upstream_list = require "rspamd_upstream_list"
-- Try to get read servers:
local upstreams_read, upstreams_write
if options['read_servers'] then
if rspamd_config then
upstreams_read = upstream_list.create(rspamd_config,
options['read_servers'], default_port)
else
upstreams_read = upstream_list.create(options['read_servers'],
default_port)
end
elseif options['servers'] then
if rspamd_config then
upstreams_read = upstream_list.create(rspamd_config,
options['servers'], default_port)
else
upstreams_read = upstream_list.create(options['servers'], default_port)
end
elseif options['server'] then
if rspamd_config then
upstreams_read = upstream_list.create(rspamd_config,
options['server'], default_port)
else
upstreams_read = upstream_list.create(options['server'], default_port)
end
end
if upstreams_read then
if options['write_servers'] then
if rspamd_config then
upstreams_write = upstream_list.create(rspamd_config,
options['write_servers'], default_port)
else
upstreams_write = upstream_list.create(options['write_servers'],
default_port)
end
else
upstreams_write = upstreams_read
end
end
-- Store options
if not result['timeout'] or result['timeout'] == default_timeout then
if options['timeout'] then
result['timeout'] = tonumber(options['timeout'])
else
result['timeout'] = default_timeout
end
end
if options['prefix'] and not result['prefix'] then
result['prefix'] = options['prefix']
end
if type(options['expand_keys']) == 'boolean' then
result['expand_keys'] = options['expand_keys']
else
result['expand_keys'] = default_expand_keys
end
if not result['db'] then
if options['db'] then
result['db'] = tostring(options['db'])
elseif options['dbname'] then
result['db'] = tostring(options['dbname'])
elseif options['database'] then
result['db'] = tostring(options['database'])
end
end
if options['password'] and not result['password'] then
result['password'] = options['password']
end
if upstreams_write and upstreams_read then
result.read_servers = upstreams_read
result.write_servers = upstreams_write
return true
end
return false
end
exports.try_load_redis_servers = try_load_redis_servers
-- This function parses redis server definition using either
-- specific server string for this module or global
-- redis section
local function rspamd_parse_redis_server(module_name, module_opts, no_fallback)
local result = {}
-- Try local options
local opts
if not module_opts then
opts = rspamd_config:get_all_opt(module_name)
else
opts = module_opts
end
if opts then
local ret
if opts.redis then
ret = try_load_redis_servers(opts.redis, rspamd_config, result)
if ret then
return result
end
end
ret = try_load_redis_servers(opts, rspamd_config, result)
if ret then
return result
end
end
if no_fallback then return nil end
-- Try global options
opts = rspamd_config:get_all_opt('redis')
if opts then
local ret
if opts[module_name] then
ret = try_load_redis_servers(opts[module_name], rspamd_config, result)
if ret then
return result
end
else
ret = try_load_redis_servers(opts, rspamd_config, result)
-- Exclude disabled
if opts['disabled_modules'] then
for _,v in ipairs(opts['disabled_modules']) do
if v == module_name then
logger.infox(rspamd_config, "NOT using default redis server for module %s: it is disabled",
module_name)
return nil
end
end
end
if ret then
logger.infox(rspamd_config, "using default redis server for module %s",
module_name)
end
end
end
if result.read_servers then
return result
else
return nil
end
end
--[[[
-- @function lua_redis.parse_redis_server(module_name, module_opts, no_fallback)
-- Extracts Redis server settings from configuration
-- @param {string} module_name name of module to get settings for
-- @param {table} module_opts settings for module or `nil` to fetch them from configuration
-- @param {boolean} no_fallback should be `true` if global settings must not be used
-- @return {table} redis server settings
-- @example
-- local rconfig = lua_redis.parse_redis_server('my_module')
-- -- rconfig contains upstream_list objects in ['write_servers'] and ['read_servers']
-- -- ['timeout'] contains timeout in seconds
-- -- ['expand_keys'] if true tells that redis key expansion is enabled
--]]
exports.rspamd_parse_redis_server = rspamd_parse_redis_server
exports.parse_redis_server = rspamd_parse_redis_server
local process_cmd = {
bitop = function(args)
local idx_l = {}
for i = 2, #args do
table.insert(idx_l, i)
end
return idx_l
end,
blpop = function(args)
local idx_l = {}
for i = 1, #args -1 do
table.insert(idx_l, i)
end
return idx_l
end,
eval = function(args)
local idx_l = {}
local numkeys = args[2]
if numkeys and tonumber(numkeys) >= 1 then
for i = 3, numkeys + 2 do
table.insert(idx_l, i)
end
end
return idx_l
end,
set = function(args)
return {1}
end,
mget = function(args)
local idx_l = {}
for i = 1, #args do
table.insert(idx_l, i)
end
return idx_l
end,
mset = function(args)
local idx_l = {}
for i = 1, #args, 2 do
table.insert(idx_l, i)
end
return idx_l
end,
sdiffstore = function(args)
local idx_l = {}
for i = 2, #args do
table.insert(idx_l, i)
end
return idx_l
end,
smove = function(args)
return {1, 2}
end,
script = function() end
}
process_cmd.append = process_cmd.set
process_cmd.auth = process_cmd.script
process_cmd.bgrewriteaof = process_cmd.script
process_cmd.bgsave = process_cmd.script
process_cmd.bitcount = process_cmd.set
process_cmd.bitfield = process_cmd.set
process_cmd.bitpos = process_cmd.set
process_cmd.brpop = process_cmd.blpop
process_cmd.brpoplpush = process_cmd.blpop
process_cmd.client = process_cmd.script
process_cmd.cluster = process_cmd.script
process_cmd.command = process_cmd.script
process_cmd.config = process_cmd.script
process_cmd.dbsize = process_cmd.script
process_cmd.debug = process_cmd.script
process_cmd.decr = process_cmd.set
process_cmd.decrby = process_cmd.set
process_cmd.del = process_cmd.mget
process_cmd.discard = process_cmd.script
process_cmd.dump = process_cmd.set
process_cmd.echo = process_cmd.script
process_cmd.evalsha = process_cmd.eval
process_cmd.exec = process_cmd.script
process_cmd.exists = process_cmd.mget
process_cmd.expire = process_cmd.set
process_cmd.expireat = process_cmd.set
process_cmd.flushall = process_cmd.script
process_cmd.flushdb = process_cmd.script
process_cmd.geoadd = process_cmd.set
process_cmd.geohash = process_cmd.set
process_cmd.geopos = process_cmd.set
process_cmd.geodist = process_cmd.set
process_cmd.georadius = process_cmd.set
process_cmd.georadiusbymember = process_cmd.set
process_cmd.get = process_cmd.set
process_cmd.getbit = process_cmd.set
process_cmd.getrange = process_cmd.set
process_cmd.getset = process_cmd.set
process_cmd.hdel = process_cmd.set
process_cmd.hexists = process_cmd.set
process_cmd.hget = process_cmd.set
process_cmd.hgetall = process_cmd.set
process_cmd.hincrby = process_cmd.set
process_cmd.hincrbyfloat = process_cmd.set
process_cmd.hkeys = process_cmd.set
process_cmd.hlen = process_cmd.set
process_cmd.hmget = process_cmd.set
process_cmd.hmset = process_cmd.set
process_cmd.hscan = process_cmd.set
process_cmd.hset = process_cmd.set
process_cmd.hsetnx = process_cmd.set
process_cmd.hstrlen = process_cmd.set
process_cmd.hvals = process_cmd.set
process_cmd.incr = process_cmd.set
process_cmd.incrby = process_cmd.set
process_cmd.incrbyfloat = process_cmd.set
process_cmd.info = process_cmd.script
process_cmd.keys = process_cmd.script
process_cmd.lastsave = process_cmd.script
process_cmd.lindex = process_cmd.set
process_cmd.linsert = process_cmd.set
process_cmd.llen = process_cmd.set
process_cmd.lpop = process_cmd.set
process_cmd.lpush = process_cmd.set
process_cmd.lpushx = process_cmd.set
process_cmd.lrange = process_cmd.set
process_cmd.lrem = process_cmd.set
process_cmd.lset = process_cmd.set
process_cmd.ltrim = process_cmd.set
process_cmd.migrate = process_cmd.script
process_cmd.monitor = process_cmd.script
process_cmd.move = process_cmd.set
process_cmd.msetnx = process_cmd.mset
process_cmd.multi = process_cmd.script
process_cmd.object = process_cmd.script
process_cmd.persist = process_cmd.set
process_cmd.pexpire = process_cmd.set
process_cmd.pexpireat = process_cmd.set
process_cmd.pfadd = process_cmd.set
process_cmd.pfcount = process_cmd.set
process_cmd.pfmerge = process_cmd.mget
process_cmd.ping = process_cmd.script
process_cmd.psetex = process_cmd.set
process_cmd.psubscribe = process_cmd.script
process_cmd.pubsub = process_cmd.script
process_cmd.pttl = process_cmd.set
process_cmd.publish = process_cmd.script
process_cmd.punsubscribe = process_cmd.script
process_cmd.quit = process_cmd.script
process_cmd.randomkey = process_cmd.script
process_cmd.readonly = process_cmd.script
process_cmd.readwrite = process_cmd.script
process_cmd.rename = process_cmd.mget
process_cmd.renamenx = process_cmd.mget
process_cmd.restore = process_cmd.set
process_cmd.role = process_cmd.script
process_cmd.rpop = process_cmd.set
process_cmd.rpoplpush = process_cmd.mget
process_cmd.rpush = process_cmd.set
process_cmd.rpushx = process_cmd.set
process_cmd.sadd = process_cmd.set
process_cmd.save = process_cmd.script
process_cmd.scard = process_cmd.set
process_cmd.sdiff = process_cmd.mget
process_cmd.select = process_cmd.script
process_cmd.setbit = process_cmd.set
process_cmd.setex = process_cmd.set
process_cmd.setnx = process_cmd.set
process_cmd.sinterstore = process_cmd.sdiff
process_cmd.sismember = process_cmd.set
process_cmd.slaveof = process_cmd.script
process_cmd.slowlog = process_cmd.script
process_cmd.smembers = process_cmd.script
process_cmd.sort = process_cmd.set
process_cmd.spop = process_cmd.set
process_cmd.srandmember = process_cmd.set
process_cmd.srem = process_cmd.set
process_cmd.strlen = process_cmd.set
process_cmd.subscribe = process_cmd.script
process_cmd.sunion = process_cmd.mget
process_cmd.sunionstore = process_cmd.mget
process_cmd.swapdb = process_cmd.script
process_cmd.sync = process_cmd.script
process_cmd.time = process_cmd.script
process_cmd.touch = process_cmd.mget
process_cmd.ttl = process_cmd.set
process_cmd.type = process_cmd.set
process_cmd.unsubscribe = process_cmd.script
process_cmd.unlink = process_cmd.mget
process_cmd.unwatch = process_cmd.script
process_cmd.wait = process_cmd.script
process_cmd.watch = process_cmd.mget
process_cmd.zadd = process_cmd.set
process_cmd.zcard = process_cmd.set
process_cmd.zcount = process_cmd.set
process_cmd.zincrby = process_cmd.set
process_cmd.zinterstore = process_cmd.eval
process_cmd.zlexcount = process_cmd.set
process_cmd.zrange = process_cmd.set
process_cmd.zrangebylex = process_cmd.set
process_cmd.zrank = process_cmd.set
process_cmd.zrem = process_cmd.set
process_cmd.zrembylex = process_cmd.set
process_cmd.zrembyrank = process_cmd.set
process_cmd.zrembyscore = process_cmd.set
process_cmd.zrevrange = process_cmd.set
process_cmd.zrevrangebyscore = process_cmd.set
process_cmd.zrevrank = process_cmd.set
process_cmd.zscore = process_cmd.set
process_cmd.zunionstore = process_cmd.eval
process_cmd.scan = process_cmd.script
process_cmd.sscan = process_cmd.set
process_cmd.hscan = process_cmd.set
process_cmd.zscan = process_cmd.set
local function get_key_indexes(cmd, args)
local idx_l = {}
cmd = string.lower(cmd)
if process_cmd[cmd] then
idx_l = process_cmd[cmd](args)
else
logger.warnx(rspamd_config, "Don't know how to extract keys for %s Redis command", cmd)
end
return idx_l
end
local gen_meta = {
principal_recipient = function(task)
return task:get_principal_recipient()
end,
principal_recipient_domain = function(task)
local p = task:get_principal_recipient()
if not p then return end
return string.match(p, '.*@(.*)')
end,
ip = function(task)
local i = task:get_ip()
if i and i:is_valid() then return i:to_string() end
end,
from = function(task)
return ((task:get_from('smtp') or E)[1] or E)['addr']
end,
from_domain = function(task)
return ((task:get_from('smtp') or E)[1] or E)['domain']
end,
from_domain_or_helo_domain = function(task)
local d = ((task:get_from('smtp') or E)[1] or E)['domain']
if d and #d > 0 then return d end
return task:get_helo()
end,
mime_from = function(task)
return ((task:get_from('mime') or E)[1] or E)['addr']
end,
mime_from_domain = function(task)
return ((task:get_from('mime') or E)[1] or E)['domain']
end,
}
local function gen_get_esld(f)
return function(task)
local d = f(task)
if not d then return end
return rspamd_util.get_tld(d)
end
end
gen_meta.smtp_from = gen_meta.from
gen_meta.smtp_from_domain = gen_meta.from_domain
gen_meta.smtp_from_domain_or_helo_domain = gen_meta.from_domain_or_helo_domain
gen_meta.esld_principal_recipient_domain = gen_get_esld(gen_meta.principal_recipient_domain)
gen_meta.esld_from_domain = gen_get_esld(gen_meta.from_domain)
gen_meta.esld_smtp_from_domain = gen_meta.esld_from_domain
gen_meta.esld_mime_from_domain = gen_get_esld(gen_meta.mime_from_domain)
gen_meta.esld_from_domain_or_helo_domain = gen_get_esld(gen_meta.from_domain_or_helo_domain)
gen_meta.esld_smtp_from_domain_or_helo_domain = gen_meta.esld_from_domain_or_helo_domain
local function get_key_expansion_metadata(task)
local md_mt = {
__index = function(self, k)
k = string.lower(k)
local v = rawget(self, k)
if v then
return v
end
if gen_meta[k] then
v = gen_meta[k](task)
rawset(self, k, v)
end
return v
end,
}
local lazy_meta = {}
setmetatable(lazy_meta, md_mt)
return lazy_meta
end
-- Performs async call to redis hiding all complexity inside function
-- task - rspamd_task
-- redis_params - valid params returned by rspamd_parse_redis_server
-- key - key to select upstream or nil to select round-robin/master-slave
-- is_write - true if need to write to redis server
-- callback - function to be called upon request is completed
-- command - redis command
-- args - table of arguments
-- extra_opts - table of optional request arguments
local function rspamd_redis_make_request(task, redis_params, key, is_write,
callback, command, args, extra_opts)
local addr
local function rspamd_redis_make_request_cb(err, data)
if err then
addr:fail()
else
addr:ok()
end
callback(err, data, addr)
end
if not task or not redis_params or not callback or not command then
return false,nil,nil
end
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
logger.errx(task, 'cannot select server to make redis request')
end
if redis_params['expand_keys'] then
local m = get_key_expansion_metadata(task)
local indexes = get_key_indexes(command, args)
for _, i in ipairs(indexes) do
args[i] = lutil.template(args[i], m)
end
end
local ip_addr = addr:get_addr()
local options = {
task = task,
callback = rspamd_redis_make_request_cb,
host = ip_addr,
timeout = redis_params['timeout'],
cmd = command,
args = args
}
if extra_opts then
for k,v in pairs(extra_opts) do
options[k] = v
end
end
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
addr:fail()
logger.warnx(task, "cannot make redis request to: %s", tostring(ip_addr))
end
return ret,conn,addr
end
--[[[
-- @function lua_redis.redis_make_request(task, redis_params, key, is_write, callback, command, args)
-- Sends a request to Redis
-- @param {rspamd_task} task task object
-- @param {table} redis_params redis configuration in format returned by lua_redis.parse_redis_server()
-- @param {string} key key to use for sharding
-- @param {boolean} is_write should be `true` if we are performing a write operating
-- @param {function} callback callback function (first parameter is error if applicable, second is a 2D array (table))
-- @param {string} command Redis command to run
-- @param {table} args Numerically indexed table containing arguments for command
--]]
exports.rspamd_redis_make_request = rspamd_redis_make_request
exports.redis_make_request = rspamd_redis_make_request
local function redis_make_request_taskless(ev_base, cfg, redis_params, key,
is_write, callback, command, args, extra_opts)
if not ev_base or not redis_params or not callback or not command then
return false,nil,nil
end
local addr
local function rspamd_redis_make_request_cb(err, data)
if err then
addr:fail()
else
addr:ok()
end
callback(err, data, addr)
end
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
logger.errx(cfg, 'cannot select server to make redis request')
end
local options = {
ev_base = ev_base,
config = cfg,
callback = rspamd_redis_make_request_cb,
host = addr:get_addr(),
timeout = redis_params['timeout'],
cmd = command,
args = args
}
if extra_opts then
for k,v in pairs(extra_opts) do
options[k] = v
end
end
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
logger.errx('cannot execute redis request')
addr:fail()
end
return ret,conn,addr
end
--[[[
-- @function lua_redis.redis_make_request_taskless(ev_base, redis_params, key, is_write, callback, command, args)
-- Sends a request to Redis in context where `task` is not available for some specific use-cases
-- Identical to redis_make_request() except in that first parameter is an `event base` object
--]]
exports.rspamd_redis_make_request_taskless = redis_make_request_taskless
exports.redis_make_request_taskless = redis_make_request_taskless
local redis_scripts = {
}
local function script_set_loaded(script)
if script.sha then
script.loaded = true
end
local wait_table = {}
for _,s in ipairs(script.waitq) do
table.insert(wait_table, s)
end
script.waitq = {}
for _,s in ipairs(wait_table) do
s(script.loaded)
end
end
local function prepare_redis_call(script)
local function merge_tables(t1, t2)
for k,v in pairs(t2) do t1[k] = v end
end
local servers = {}
local options = {}
if script.redis_params.read_servers then
merge_tables(servers, script.redis_params.read_servers:all_upstreams())
end
if script.redis_params.write_servers then
merge_tables(servers, script.redis_params.write_servers:all_upstreams())
end
-- Call load script on each server, set loaded flag
script.in_flight = #servers
for _,s in ipairs(servers) do
local cur_opts = {
host = s:get_addr(),
timeout = script.redis_params['timeout'],
cmd = 'SCRIPT',
args = {'LOAD', script.script },
upstream = s
}
if script.redis_params['password'] then
cur_opts['password'] = script.redis_params['password']
end
if script.redis_params['db'] then
cur_opts['dbname'] = script.redis_params['db']
end
table.insert(options, cur_opts)
end
return options
end
local function load_script_task(script, task)
local rspamd_redis = require "rspamd_redis"
local opts = prepare_redis_call(script)
for _,opt in ipairs(opts) do
opt.task = task
opt.callback = function(err, data)
if err then
logger.errx(task, 'cannot upload script to %s: %s',
opt.upstream:get_addr(), err)
opt.upstream:fail()
script.fatal_error = err
else
opt.upstream:ok()
logger.infox(task,
"uploaded redis script to %s with id %s, sha: %s",
opt.upstream:get_addr(), script.id, data)
script.sha = data -- We assume that sha is the same on all servers
end
script.in_flight = script.in_flight - 1
if script.in_flight == 0 then
script_set_loaded(script)
end
end
local ret = rspamd_redis.make_request(opt)
if not ret then
logger.errx('cannot execute redis request to load script on %s',
opt.upstream:get_addr())
script.in_flight = script.in_flight - 1
opt.upstream:fail()
end
if script.in_flight == 0 then
script_set_loaded(script)
end
end
end
local function load_script_taskless(script, cfg, ev_base)
local rspamd_redis = require "rspamd_redis"
local opts = prepare_redis_call(script)
for _,opt in ipairs(opts) do
opt.config = cfg
opt.ev_base = ev_base
opt.callback = function(err, data)
if err then
logger.errx(cfg, 'cannot upload script to %s: %s',
opt.upstream:get_addr(), err)
opt.upstream:fail()
script.fatal_error = err
else
opt.upstream:ok()
logger.infox(cfg,
"uploaded redis script to %s with id %s, sha: %s",
opt.upstream:get_addr(), script.id, data)
script.sha = data -- We assume that sha is the same on all servers
end
script.in_flight = script.in_flight - 1
if script.in_flight == 0 then
script_set_loaded(script)
end
end
local ret = rspamd_redis.make_request(opt)
if not ret then
logger.errx('cannot execute redis request to load script on %s',
opt.upstream:get_addr())
script.in_flight = script.in_flight - 1
opt.upstream:fail()
end
if script.in_flight == 0 then
script_set_loaded(script)
end
end
end
local function load_redis_script(script, cfg, ev_base, _)
if script.redis_params then
load_script_taskless(script, cfg, ev_base)
end
end
local function add_redis_script(script, redis_params)
local new_script = {
loaded = false,
redis_params = redis_params,
script = script,
waitq = {}, -- callbacks pending for script being loaded
id = #redis_scripts + 1
}
-- Register on load function
rspamd_config:add_on_load(function(cfg, ev_base, worker)
load_redis_script(new_script, cfg, ev_base, worker)
end)
table.insert(redis_scripts, new_script)
return #redis_scripts
end
exports.add_redis_script = add_redis_script
local function exec_redis_script(id, params, callback, keys, args)
local redis_args = {}
if not redis_scripts[id] then
logger.errx("cannot find registered script with id %s", id)
return false
end
local script = redis_scripts[id]
if script.fatal_error then
callback(script.fatal_error, nil)
return true
end
if not script.redis_params then
callback('no redis servers defined', nil)
return true
end
local function do_call(can_reload)
local function redis_cb(err, data)
if not err then
callback(err, data)
elseif string.match(err, 'NOSCRIPT') then
-- Schedule restart
script.sha = nil
if can_reload then
table.insert(script.waitq, do_call)
if script.in_flight == 0 then
-- Reload scripts if this has not been initiated yet
if params.task then
load_script_task(script, params.task)
else
load_script_taskless(script, rspamd_config, params.ev_base)
end
end
else
callback(err, data)
end
else
callback(err, data)
end
end
if #redis_args == 0 then
table.insert(redis_args, script.sha)
table.insert(redis_args, tostring(#keys))
for _,k in ipairs(keys) do
table.insert(redis_args, k)
end
if type(args) == 'table' then
for _, a in ipairs(args) do
table.insert(redis_args, a)
end
end
end
if params.task then
if not rspamd_redis_make_request(params.task, script.redis_params,
params.key, params.is_write, redis_cb, 'EVALSHA', redis_args) then
callback('Cannot make redis request', nil)
end
else
if not redis_make_request_taskless(params.ev_base, rspamd_config,
script.redis_params,
params.key, params.is_write, redis_cb, 'EVALSHA', redis_args) then
callback('Cannot make redis request', nil)
end
end
end
if script.loaded then
do_call(true)
else
-- Delayed until scripts are loaded
if not params.task then
table.insert(script.waitq, do_call)
else
-- TODO: fix taskfull requests
callback('NOSCRIPT', nil)
end
end
return true
end
exports.exec_redis_script = exec_redis_script
local function redis_connect_sync(redis_params, is_write, key, cfg)
if not redis_params then
return false,nil
end
local rspamd_redis = require "rspamd_redis"
local addr
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
logger.errx(cfg, 'cannot select server to make redis request')
end
local options = {
host = addr:get_addr(),
timeout = redis_params['timeout'],
}
local ret,conn = rspamd_redis.connect_sync(options)
if not ret then
logger.errx('cannot execute redis request: %s', conn)
addr:fail()
return false,nil,addr
end
if conn then
if redis_params['password'] then
conn:add_cmd('AUTH', {redis_params['password']})
end
if redis_params['db'] then
conn:add_cmd('SELECT', {tostring(redis_params['db'])})
elseif redis_params['dbname'] then
conn:add_cmd('SELECT', {tostring(redis_params['dbname'])})
end
end
return ret,conn,addr
end
exports.redis_connect_sync = redis_connect_sync
return exports
|