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
|
--[[
Copyright (c) 2018, 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 module contains 'selectors' implementation: code to extract data
-- from Rspamd tasks and compose those together
--
-- Read more at https://rspamd.com/doc/configuration/selectors.html
--[[[
-- @module lua_selectors
-- This module contains 'selectors' implementation: code to extract data
-- from Rspamd tasks and compose those together.
-- Typical selector looks like this: header(User).lower.substring(1, 2):ip
--]]
local exports = {}
local logger = require 'rspamd_logger'
local fun = require 'fun'
local lua_util = require "lua_util"
local M = "selectors"
local E = {}
local extractors = {
['id'] = {
['get_value'] = function(_, args)
if args[1] then
return args[1], 'string'
end
return '','string'
end,
['description'] = [[Return value from function's argument or an empty string,
For example, `id('Something')` returns a string 'Something']],
},
-- Get source IP address
['ip'] = {
['get_value'] = function(task)
local ip = task:get_ip()
if ip and ip:is_valid() then return ip,'userdata' end
return nil
end,
['description'] = [[Get source IP address]],
},
-- Get MIME from
['from'] = {
['get_value'] = function(task, args)
local from = task:get_from(args[1] or 0)
if ((from or E)[1] or E).addr then
return from[1],'table'
end
return nil
end,
['description'] = [[Get MIME or SMTP from (e.g. `from('smtp')` or `from('mime')`,
uses any type by default)]],
},
['rcpts'] = {
['get_value'] = function(task, args)
local rcpts = task:get_recipients(args[1] or 0)
if ((rcpts or E)[1] or E).addr then
return rcpts,'table_list'
end
return nil
end,
['description'] = [[Get MIME or SMTP rcpts (e.g. `rcpts('smtp')` or `rcpts('mime')`,
uses any type by default)]],
},
-- Get country (ASN module must be executed first)
['country'] = {
['get_value'] = function(task)
local country = task:get_mempool():get_variable('country')
if not country then
return nil
else
return country,'string'
end
end,
['description'] = [[Get country (ASN module must be executed first)]],
},
-- Get ASN number
['asn'] = {
['type'] = 'string',
['get_value'] = function(task)
local asn = task:get_mempool():get_variable('asn')
if not asn then
return nil
else
return asn,'string'
end
end,
['description'] = [[Get AS number (ASN module must be executed first)]],
},
-- Get authenticated username
['user'] = {
['get_value'] = function(task)
local auser = task:get_user()
if not auser then
return nil
else
return auser,'string'
end
end,
['description'] = 'Get authenticated user name',
},
-- Get principal recipient
['to'] = {
['get_value'] = function(task)
return task:get_principal_recipient(),'string'
end,
['description'] = 'Get principal recipient',
},
-- Get content digest
['digest'] = {
['get_value'] = function(task)
return task:get_digest(),'string'
end,
['description'] = 'Get content digest',
},
-- Get list of all attachments digests
['attachments'] = {
['get_value'] = function(task)
local parts = task:get_parts() or E
local digests = {}
for _,p in ipairs(parts) do
if p:get_filename() then
table.insert(digests, p:get_digest())
end
end
if #digests > 0 then
return digests,'string_list'
end
return nil
end,
['description'] = 'Get list of all attachments digests',
},
-- Get all attachments files
['files'] = {
['get_value'] = function(task)
local parts = task:get_parts() or E
local files = {}
for _,p in ipairs(parts) do
local fname = p:get_filename()
if fname then
table.insert(files, fname)
end
end
if #files > 0 then
return files,'string_list'
end
return nil
end,
['description'] = 'Get all attachments files',
},
-- Get helo value
['helo'] = {
['get_value'] = function(task)
return task:get_helo(),'string'
end,
['description'] = 'Get helo value',
},
-- Get header with the name that is expected as an argument. Returns list of
-- headers with this name
['header'] = {
['get_value'] = function(task, args)
local strong = false
if args[2] then
if args[2]:match('strong') then
strong = true
end
if args[2]:match('full') then
return task:get_header_full(args[1], strong),'table_list'
end
return task:get_header(args[1], strong),'string'
else
return task:get_header(args[1]),'string'
end
end,
['description'] = [[Get header with the name that is expected as an argument.
The optional second argument accepts list of flags:
- `full`: returns all headers with this name with all data (like task:get_header_full())
- `strong`: use case sensitive match when matching header's name]],
},
-- Get list of received headers (returns list of tables)
['received'] = {
['get_value'] = function(task, args)
local rh = task:get_received_headers()
if args[1] and rh then
return fun.map(function(r) return r[args[1]] end, rh), 'string_list'
end
return rh,'table_list'
end,
['description'] = [[Get list of received headers.
If no arguments specified, returns list of tables. Otherwise, selects a specific element,
e.g. `by_hostname`]],
},
-- Get all urls
['urls'] = {
['get_value'] = function(task, args)
local urls = task:get_urls()
if args[1] and urls then
return fun.map(function(r) return r[args[1]](r) end, urls), 'string_list'
end
return urls,'userdata_list'
end,
['description'] = [[Get list of all urls.
If no arguments specified, returns list of url objects. Otherwise, calls a specific method,
e.g. `get_tld`]],
},
-- Get all emails
['emails'] = {
['get_value'] = function(task, args)
local urls = task:get_emails()
if args[1] and urls then
return fun.map(function(r) return r[args[1]](r) end, urls), 'string_list'
end
return urls,'userdata_list'
end,
['description'] = [[Get list of all emails.
If no arguments specified, returns list of url objects. Otherwise, calls a specific method,
e.g. `get_user`]],
},
-- Get specific pool var. The first argument must be variable name,
-- the second argument is optional and defines the type (string by default)
['pool_var'] = {
['get_value'] = function(task, args)
local type = args[2] or 'string'
return task:get_mempool():get_variable(args[1], type),(type)
end,
['description'] = [[Get specific pool var. The first argument must be variable name,
the second argument is optional and defines the type (string by default)]],
},
-- Get specific HTTP request header. The first argument must be header name.
['request_header'] = {
['get_value'] = function(task, args)
local hdr = task:get_request_header(args[1])
if hdr then
return tostring(hdr),'string'
end
return nil
end,
['description'] = [[Get specific HTTP request header.
The first argument must be header name.]],
},
-- Get task date, optionally formatted
['time'] = {
['get_value'] = function(task, args)
local what = args[1] or 'message'
local dt = task:get_date{format = what, gmt = true}
if dt then
if args[2] then
-- Should be in format !xxx, as dt is in GMT
return os.date(args[2], dt),'string'
end
return tostring(dt),'string'
end
return nil
end,
['description'] = [[Get task timestamp. The first argument is type:
- `connect`: connection timestamp (default)
- `message`: timestamp as defined by `Date` header
The second argument is optional time format, see [os.date](http://pgl.yoyo.org/luai/i/os.date) description]]
}
}
local function pure_type(ltype)
return ltype:match('^(.*)_list$')
end
local transform_function = {
-- Get hostname from url or a list of urls
['get_host'] = {
['types'] = {
['url'] = true
},
['map_type'] = 'string',
['process'] = function(inp, t)
return inp:get_host(),'string'
end,
['description'] = 'Get hostname from url or a list of urls',
},
-- Get tld from url or a list of urls
['get_tld'] = {
['types'] = {
['url'] = true
},
['map_type'] = 'string',
['process'] = function(inp, t)
return inp:get_tld()
end,
['description'] = 'Get tld from url or a list of urls',
},
-- Get address
['addr'] = {
['types'] = {
['email'] = true
},
['map_type'] = 'string',
['process'] = function(inp, _)
return inp.addr
end,
['description'] = 'Get email address as a string',
},
-- Get address
['name'] = {
['types'] = {
['email'] = true
},
['map_type'] = 'string',
['process'] = function(inp, _)
return inp.name
end,
['description'] = 'Get email name as a string',
},
-- Returns the lowercased string
['lower'] = {
['types'] = {
['string'] = true,
},
['map_type'] = 'string',
['process'] = function(inp, _)
return inp:lower(),'string'
end,
['description'] = 'Returns the lowercased string',
},
-- Returns the first element
['first'] = {
['types'] = {
['list'] = true,
},
['process'] = function(inp, t)
return fun.head(inp),pure_type(t)
end,
['description'] = 'Returns the first element',
},
-- Returns the last element
['last'] = {
['types'] = {
['list'] = true,
},
['process'] = function(inp, t)
return fun.nth(#inp, inp),pure_type(t)
end,
['description'] = 'Returns the last element',
},
-- Returns the nth element
['nth'] = {
['types'] = {
['list'] = true,
},
['process'] = function(inp, t, args)
return fun.nth(tonumber(args[1]) or 1, inp),pure_type(t)
end,
['description'] = 'Returns the nth element',
},
['take_n'] = {
['types'] = {
['list'] = true,
},
['process'] = function(inp, t, args)
return fun.take_n(tonumber(args[1]) or 1, inp),t
end,
['description'] = 'Returns the n first elements',
},
['drop_n'] = {
['types'] = {
['list'] = true,
},
['process'] = function(inp, t, args)
return fun.drop_n(tonumber(args[1]) or 1, inp),t
end,
['description'] = 'Returns list without the first n elements',
},
-- Joins strings into a single string using separator in the argument
['join'] = {
['types'] = {
['string_list'] = true
},
['process'] = function(inp, _, args)
return table.concat(fun.totable(inp), args[1] or ''), 'string'
end,
['description'] = 'Joins strings into a single string using separator in the argument',
},
-- Create a digest from string or a list of strings
['digest'] = {
['types'] = {
['string'] = true
},
['map_type'] = 'hash',
['process'] = function(inp, _, args)
local hash = require 'rspamd_cryptobox_hash'
local ht = args[1] or 'blake2'
local h = hash:create_specific(ht):update(inp)
if args[2] then
return h[args[2]](h),'string' -- Call hash method
end
return h, 'hash'
end,
['description'] = 'Create a digest from string or a list of strings',
},
-- Encode hash to string (using hex encoding by default)
['encode'] = {
['types'] = {
['hash'] = true
},
['map_type'] = 'string',
['process'] = function(inp, _, args)
local how = args[1] or 'hex'
if how == 'hex' then
return inp:hex()
elseif how == 'base32' then
return inp:base32()
elseif how == 'base64' then
return inp:base64()
end
end,
['description'] = 'Encode hash to string (using hex encoding by default)',
},
-- Extracts substring
['substring'] = {
['types'] = {
['string'] = true
},
['map_type'] = 'string',
['process'] = function(inp, _, args)
local start_pos = args[1] or 1
local end_pos = args[2] or -1
return inp:sub(start_pos, end_pos), 'string'
end,
['description'] = 'Extracts substring',
},
-- Regexp matching
['regexp'] = {
['types'] = {
['string'] = true
},
['map_type'] = 'string',
['process'] = function(inp, _, args)
local rspamd_regexp = require "rspamd_regexp"
local re = rspamd_regexp.create_cached(args[1])
if not re then
logger.errx('invalid regexp: %s', args[1])
return nil
end
local res = re:search(inp, false, true)
if res then
if #res == 1 then
return res[1],'string'
end
return res,'string_list'
end
return nil
end,
['description'] = 'Regexp matching',
},
-- Drops input value and return values from function's arguments or an empty string
['id'] = {
['types'] = {
['string'] = true,
['list'] = true,
},
['map_type'] = 'string',
['process'] = function(_, _, args)
if args[1] and args[2] then
return fun.map(tostring, args),'string_list'
elseif args[1] then
return args[1],'string'
end
return '','string'
end,
['description'] = 'Drops input value and return values from function\'s arguments or an empty string',
},
-- Extracts table value from key-value list
['elt'] = {
['types'] = {
['kv'] = true,
},
['map_type'] = 'string',
['process'] = function(inp, t, args)
return inp[args[1]],'string'
end,
['description'] = 'Extracts table value from key-value list',
},
-- Call specific userdata method
['method'] = {
['types'] = {
['email'] = true,
['url'] = true,
['ip'] = true,
},
['map_type'] = 'string',
['process'] = function(inp, _, args)
return inp[args[1]](inp)
end,
['description'] = 'Call specific userdata method',
},
-- Boolean function in, returns either nil or its input if input is in args list
['in'] = {
['types'] = {
['string'] = true,
},
['map_type'] = 'string',
['process'] = function(inp, t, args)
for _,a in ipairs(args) do if a == inp then return inp,t end end
return nil
end,
['description'] = [[Boolean function in.
Returns either nil or its input if input is in args list]],
},
['not_in'] = {
['types'] = {
['string'] = true,
},
['map_type'] = 'string',
['process'] = function(inp, t, args)
for _,a in ipairs(args) do if a == inp then return nil end end
return inp,t
end,
['description'] = [[Boolean function not in.
Returns either nil or its input if input is not in args list]],
},
}
local function process_selector(task, sel)
local function allowed_type(t)
if t == 'string' or t == 'text' or t == 'string_list' or t == 'text_list' then
return true
end
return false
end
local function list_type(t)
return pure_type(t)
end
local function implicit_tostring(t, ud_or_table)
if t == 'table' then
-- Table (very special)
if ud_or_table.value then
return ud_or_table.value,'string'
elseif ud_or_table.addr then
return ud_or_table.addr,'string'
end
return logger.slog("%s", ud_or_table),'string'
else
return tostring(ud_or_table),'string'
end
end
local input,etype = sel.selector.get_value(task, sel.selector.args)
if not input then
lua_util.debugm(M, task, 'no value extracted for %s', sel.selector.name)
return nil
end
lua_util.debugm(M, task, 'extracted %s, type %s',
sel.selector.name, etype)
local pipe = sel.processor_pipe or E
if etype:match('^userdata') or etype:match('^table') then
-- Apply userdata conversion first
local first_elt = pipe[1]
if first_elt and first_elt.method then
-- Explicit conversion
local meth = first_elt
if meth.types[etype] then
lua_util.debugm(M, task, 'apply method `%s` to %s',
meth.name, etype)
input,etype = meth.process(input, etype)
else
local pt = pure_type(etype)
if meth.types[pt] then
lua_util.debugm(M, task, 'map method `%s` to list of %s',
meth.name, pt)
input = fun.map(function(list_elt)
local ret, _ = meth.process(list_elt, pt)
return ret
end, input)
etype = 'string_list'
end
end
-- Remove method from the pipeline
pipe = fun.drop_n(1, pipe)
else
-- Implicit conversion
local pt = pure_type(etype)
if not pt then
lua_util.debugm(M, task, 'apply implicit conversion %s->string', etype)
input = implicit_tostring(etype, input)
etype = 'string'
else
lua_util.debugm(M, task, 'apply implicit map %s->string', pt)
input = fun.map(function(list_elt)
local ret = implicit_tostring(pt, list_elt)
return ret
end, input)
etype = 'string_list'
end
end
end
-- Now we fold elements using left fold
local function fold_function(acc, x)
if acc == nil or acc[1] == nil then
lua_util.debugm(M, task, 'do not apply %s, accumulator is nil', x.name)
return nil
end
local value = acc[1]
local t = acc[2]
if not x.types[t] then
local pt = pure_type(t)
if pt and x.types['list'] then
-- Generic list processor
lua_util.debugm(M, task, 'apply list function `%s` to %s', x.name, t)
return {x.process(value, t, x.args)}
elseif pt and x.map_type and x.types[pt] then
local map_type = x.map_type .. '_list'
lua_util.debugm(M, task, 'map `%s` to list of %s resulting %s',
x.name, pt, map_type)
return {fun.map(function(list_elt)
if not list_elt then return nil end
local ret, _ = x.process(list_elt, pt, x.args)
return ret
end, value), map_type}
end
logger.errx(task, 'cannot apply transform %s for type %s', x.name, t)
return nil
end
lua_util.debugm(M, task, 'apply %s to %s', x.name, t)
return {x.process(value, t, x.args)}
end
local res = fun.foldl(fold_function,
{input, etype},
pipe)
if not res or not res[1] then return nil end -- Pipeline failed
if not allowed_type(res[2]) then
-- Search for implicit conversion
local pt = pure_type(res[2])
if pt then
lua_util.debugm(M, task, 'apply implicit map %s->string_list', pt)
res[1] = fun.map(function(e) return implicit_tostring(pt, e) end, res[1])
res[2] = 'string_list'
else
res[1] = implicit_tostring(res[2], res[1])
res[2] = 'string'
end
end
if list_type(res[2]) then
-- Convert to table as it might have a functional form
res[1] = fun.totable(res[1])
end
lua_util.debugm(M, task, 'final selector type: %s, value: %s', res[2], res[1])
return res[1]
end
local function make_grammar()
local l = require "lpeg"
local spc = l.S(" \t\n")^0
local atom = l.C((l.R("az") + l.R("AZ") + l.R("09") + l.S("_-"))^1)
local singlequoted_string = l.P "'" * l.C(((1 - l.S "'\r\n\f\\") + (l.P'\\' * 1))^0) * "'"
local doublequoted_string = l.P '"' * l.C(((1 - l.S'"\r\n\f\\') + (l.P'\\' * 1))^0) * '"'
local argument = atom + singlequoted_string + doublequoted_string
local dot = l.P(".")
local semicolon = l.P(":")
local obrace = "(" * spc
local ebrace = spc * ")"
local comma = spc * "," * spc
local sel_separator = spc * l.S";*" * spc
return l.P{
"LIST";
LIST = l.Ct(l.V("EXPR")) * (sel_separator * l.Ct(l.V("EXPR")))^0,
EXPR = l.V("FUNCTION") * (semicolon * l.V("METHOD"))^-1 * (dot * l.V("PROCESSOR"))^0,
PROCESSOR = l.Ct(atom * spc * (obrace * l.V("ARG_LIST") * ebrace)^0),
FUNCTION = l.Ct(atom * spc * (obrace * l.V("ARG_LIST") * ebrace)^0),
METHOD = l.Ct(atom / function(e) return '__' .. e end * spc * (obrace * l.V("ARG_LIST") * ebrace)^0),
ARG_LIST = l.Ct((argument * comma^0)^0)
}
end
local parser = make_grammar()
--[[[
-- @function lua_selectors.parse_selector(cfg, str)
--]]
exports.parse_selector = function(cfg, str)
local parsed = {parser:match(str)}
local output = {}
if not parsed or not parsed[1] then return nil end
-- Output AST format is the following:
-- table of individual selectors
-- each selector: list of functions
-- each function: function name + optional list of arguments
for _,sel in ipairs(parsed) do
local res = {
selector = {},
processor_pipe = {},
}
local selector_tbl = sel[1]
if not selector_tbl then
logger.errx(cfg, 'no selector represented')
return nil
end
if not extractors[selector_tbl[1]] then
logger.errx(cfg, 'selector %s is unknown', selector_tbl[1])
return nil
end
res.selector = lua_util.shallowcopy(extractors[selector_tbl[1]])
res.selector.name = selector_tbl[1]
res.selector.args = selector_tbl[2] or E
lua_util.debugm(M, cfg, 'processed selector %s, args: %s',
res.selector.name, res.selector.args)
local it_happened = false
-- Now process processors pipe
fun.each(function(proc_tbl)
local proc_name = proc_tbl[1]
if proc_name:match('^__') then
-- Special case - method
local method_name = proc_name:match('^__(.*)$')
local processor = {
name = method_name,
method = true,
args = proc_tbl[2] or E,
types = {
userdata = true,
table = true,
},
map_type = 'string',
process = function(inp, t, args)
if t == 'userdata' then
return inp[method_name](inp, args),string
else
-- Table
return inp[method_name],string
end
end,
}
lua_util.debugm(M, cfg, 'attached method %s to selector %s, args: %s',
proc_name, res.selector.name, processor.args)
table.insert(res.processor_pipe, processor)
else
if not transform_function[proc_name] then
logger.errx(cfg, 'processor %s is unknown', proc_name)
it_happened = true
return nil
end
local processor = lua_util.shallowcopy(transform_function[proc_name])
processor.name = proc_name
processor.args = proc_tbl[2] or E
lua_util.debugm(M, cfg, 'attached processor %s to selector %s, args: %s',
proc_name, res.selector.name, processor.args)
table.insert(res.processor_pipe, processor)
end
end, fun.tail(sel))
if it_happened then
logger.errx(cfg, 'unknown processor used, exiting')
return nil
end
table.insert(output, res)
end
return output
end
--[[[
-- @function lua_selectors.register_extractor(cfg, name, selector)
--]]
exports.register_extractor = function(cfg, name, selector)
if selector.get_value then
if extractors[name] then
logger.warnx(cfg, 'redefining selector %s', name)
end
extractors[name] = selector
return true
end
logger.errx(cfg, 'bad selector %s', name)
return false
end
--[[[
-- @function lua_selectors.register_transform(cfg, name, transform)
--]]
exports.register_transform = function(cfg, name, transform)
if transform.process and transform.types then
if transform_function[name] then
logger.warnx(cfg, 'redefining transform function %s', name)
end
transform_function[name] = transform
return true
end
logger.errx(cfg, 'bad transform function %s', name)
return false
end
--[[[
-- @function lua_selectors.process_selectors(task, selectors_pipe)
--]]
exports.process_selectors = function(task, selectors_pipe)
local ret = {}
for _,sel in ipairs(selectors_pipe) do
local r = process_selector(task, sel)
-- If any element is nil, then the whole selector is nil
if not r then return nil end
table.insert(ret, r)
end
return ret
end
--[[[
-- @function lua_selectors.combine_selectors(task, selectors, delimiter)
--]]
exports.combine_selectors = function(_, selectors, delimiter)
if not delimiter then delimiter = '' end
if not selectors then return nil end
local all_strings = fun.all(function(s) return type(s) == 'string' end, selectors)
if all_strings then
return table.concat(selectors, delimiter)
else
-- We need to do a spill on each table selector
-- e.g. s:tbl:s -> s:telt1:s + s:telt2:s ...
local tbl = {}
local res = {}
local in_prefix = true
for i,s in ipairs(selectors) do
if type(s) == 'string' then
rawset(tbl, i, fun.duplicate(s))
elseif type(s) == 'userdata' then
rawset(tbl, i, fun.duplicate(tostring(s)))
else
rawset(tbl, i, s)
end
end
fun.each(function(...)
table.insert(res, table.concat({...}, delimiter))
end, fun.zip(lua_util.unpack(tbl)))
return res
end
end
--[[[
-- @function lua_selectors.create_closure(cfg, selector_str, delimiter='')
--]]
exports.create_selector_closure = function(cfg, selector_str, delimiter)
local selector = exports.parse_selector(cfg, selector_str)
if not selector then
return nil
end
return function(task)
local res = exports.process_selectors(task, selector)
if res then
return exports.combine_selectors(nil, res, delimiter)
end
return nil
end
end
local function display_selectors(tbl)
return fun.tomap(fun.map(function(k,v)
return k, fun.tomap(fun.filter(function(kk, vv)
return type(vv) ~= 'function'
end, v))
end, tbl))
end
exports.list_extractors = function()
return display_selectors(extractors)
end
exports.list_transforms = function()
return display_selectors(transform_function)
end
return exports
|