aboutsummaryrefslogtreecommitdiffstats
path: root/lualib/rspamd_config_transform.lua
diff options
context:
space:
mode:
authorVsevolod Stakhov <vsevolod@highsecure.ru>2018-02-23 13:20:14 +0000
committerVsevolod Stakhov <vsevolod@highsecure.ru>2018-02-23 13:20:14 +0000
commiteb75c68f30b346b352e69eae90c363c8ef113175 (patch)
tree4a48cfb4654e5b97f9ec2b93c5c7adc5e47e649a /lualib/rspamd_config_transform.lua
parent24aec6cd1d0fc0ebbf7baa0f0b78a858e16b5ce1 (diff)
downloadrspamd-eb75c68f30b346b352e69eae90c363c8ef113175.tar.gz
rspamd-eb75c68f30b346b352e69eae90c363c8ef113175.zip
[Refactor] Rename all lua libraries in the common way
Diffstat (limited to 'lualib/rspamd_config_transform.lua')
-rw-r--r--lualib/rspamd_config_transform.lua295
1 files changed, 0 insertions, 295 deletions
diff --git a/lualib/rspamd_config_transform.lua b/lualib/rspamd_config_transform.lua
deleted file mode 100644
index 0823012ba..000000000
--- a/lualib/rspamd_config_transform.lua
+++ /dev/null
@@ -1,295 +0,0 @@
---[[
-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 function override_defaults(def, override)
- if not override then
- return def
- end
- if not def then
- return override
- end
- for k,v in pairs(override) do
- if def[k] then
- if type(v) == 'table' then
- def[k] = override_defaults(def[k], v)
- else
- def[k] = v
- end
- else
- def[k] = v
- end
- end
-
- return def
-end
-
-local function is_implicit(t)
- local mt = getmetatable(t)
-
- return mt and mt.class and mt.class == 'ucl.type.impl_array'
-end
-
-local function metric_pairs(t)
- -- collect the keys
- local keys = {}
- local implicit_array = is_implicit(t)
-
- local function gen_keys(tbl)
- if implicit_array then
- for _,v in ipairs(tbl) do
- if v.name then
- table.insert(keys, {v.name, v})
- v.name = nil
- else
- -- Very tricky to distinguish:
- -- group {name = "foo" ... } + group "blah" { ... }
- for gr_name,gr in pairs(v) do
- if type(gr_name) ~= 'number' then
- -- We can also have implicit arrays here
- local gr_implicit = is_implicit(gr)
-
- if gr_implicit then
- for _,gr_elt in ipairs(gr) do
- table.insert(keys, {gr_name, gr_elt})
- end
- else
- table.insert(keys, {gr_name, gr})
- end
- end
- end
- end
- end
- else
- if tbl.name then
- table.insert(keys, {tbl.name, tbl})
- tbl.name = nil
- else
- for k,v in pairs(tbl) do
- if type(k) ~= 'number' then
- -- We can also have implicit arrays here
- local sym_implicit = is_implicit(v)
-
- if sym_implicit then
- for _,elt in ipairs(v) do
- table.insert(keys, {k, elt})
- end
- else
- table.insert(keys, {k, v})
- end
- end
- end
- end
- end
- end
-
- gen_keys(t)
-
- -- return the iterator function
- local i = 0
- return function()
- i = i + 1
- if keys[i] then
- return keys[i][1], keys[i][2]
- end
- end
-end
-
-local function group_transform(cfg, k, v)
- if v.name then k = v.name end
-
- local new_group = {
- symbols = {}
- }
-
- if v.enabled then new_group.enabled = v.enabled end
- if v.disabled then new_group.disabled = v.disabled end
- if v.max_score then new_group.max_score = v.max_score end
-
- if v.symbol then
- for sk,sv in metric_pairs(v.symbol) do
- if sv.name then
- sk = sv.name
- sv.name = nil -- Remove field
- end
-
- new_group.symbols[sk] = sv
- end
- end
-
- if not cfg.group then cfg.group = {} end
-
- if cfg.group[k] then
- cfg.group[k] = override_defaults(cfg.group[k], new_group)
- else
- cfg.group[k] = new_group
- end
-
- logger.infox("overriding group %s from the legacy metric settings", k)
-end
-
-local function symbol_transform(cfg, k, v)
- -- first try to find any group where there is a definition of this symbol
- for gr_n, gr in pairs(cfg.group) do
- if gr.symbols and gr.symbols[k] then
- -- We override group symbol with ungrouped symbol
- logger.infox("overriding group symbol %s in the group %s", k, gr_n)
- gr.symbols[k] = override_defaults(gr.symbols[k], v)
- return
- end
- end
- -- Now check what Rspamd knows about this symbol
- local sym = rspamd_config:get_metric_symbol(k)
-
- if not sym or not sym.group then
- -- Otherwise we just use group 'ungrouped'
- if not cfg.group.ungrouped then
- cfg.group.ungrouped = {
- symbols = {}
- }
- end
-
- cfg.group.ungrouped.symbols[k] = v
- logger.debugx("adding symbol %s to the group 'ungrouped'", k)
- end
-end
-
-local function test_groups(groups)
- local all_symbols = {}
- for gr_name, gr in pairs(groups) do
- if not gr.symbols then
- local cnt = 0
- for _,_ in pairs(gr) do cnt = cnt + 1 end
-
- if cnt == 0 then
- logger.errx('group %s is empty', gr_name)
- else
- logger.infox('group %s has no symbols', gr_name)
- end
-
- else
- for sn,_ in pairs(gr.symbols) do
- if all_symbols[sn] then
- logger.errx('symbol %s has registered in multiple groups: %s and %s',
- sn, all_symbols[sn], gr_name)
- else
- all_symbols[sn] = gr_name
- end
- end
- end
- end
-end
-
-local function convert_metric(cfg, metric)
- if metric.actions then
- cfg.actions = override_defaults(cfg.actions, metric.actions)
- logger.infox("overriding actions from the legacy metric settings")
- end
- if metric.unknown_weight then
- cfg.actions.unknown_weight = metric.unknown_weight
- end
-
- if metric.subject then
- logger.infox("overriding subject from the legacy metric settings")
- cfg.actions.subject = metric.subject
- end
-
- if metric.group then
- for k, v in metric_pairs(metric.group) do
- group_transform(cfg, k, v)
- end
- else
- if not cfg.group then
- cfg.group = {
- ungrouped = {
- symbols = {}
- }
- }
- end
- end
-
- if metric.symbol then
- for k, v in metric_pairs(metric.symbol) do
- symbol_transform(cfg, k, v)
- end
- end
-
- return cfg
-end
-
--- Converts a table of groups indexed by number (implicit array) to a
--- merged group definition
-local function merge_groups(groups)
- local ret = {}
- for k,gr in pairs(groups) do
- if type(k) == 'number' then
- for key,sec in pairs(gr) do
- ret[key] = sec
- end
- else
- ret[k] = gr
- end
- end
-
- return ret
-end
-
-return function(cfg)
- local ret = false
-
- if cfg['metric'] then
- for _, v in metric_pairs(cfg.metric) do
- cfg = convert_metric(cfg, v)
- end
- ret = true
- end
-
- if not cfg.actions then
- logger.errx('no actions defined')
- else
- -- Perform sanity check for actions
- local actions_defs = {'greylist', 'add header', 'add_header',
- 'rewrite subject', 'rewrite_subject', 'reject'}
-
- if not cfg.actions['no action'] and not cfg.actions['no_action'] and
- not cfg.actions['accept'] then
- for _,d in ipairs(actions_defs) do
- if cfg.actions[d] then
- if cfg.actions[d] < 0 then
- cfg.actions['no action'] = cfg.actions[d] - 0.001
- logger.infox('set no action score to: %s, as action %s has negative score',
- cfg.actions['no action'], d)
- break
- end
- end
- end
- end
- end
-
- if not cfg.group then
- logger.errx('no symbol groups defined')
- else
- if cfg.group[1] then
- -- We need to merge groups
- cfg.group = merge_groups(cfg.group)
- ret = true
- end
- test_groups(cfg.group)
- end
-
- return ret, cfg
-end