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
|
/*
* Copyright (c) 2009-2015, Vsevolod Stakhov
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY AUTHOR ''AS IS'' AND ANY
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL AUTHOR BE LIABLE FOR ANY
* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef RSPAMD_SYMBOLS_CACHE_H
#define RSPAMD_SYMBOLS_CACHE_H
#include "config.h"
#include "ucl.h"
#include <lua.h>
#include <event.h>
struct rspamd_task;
struct rspamd_config;
struct symbols_cache;
typedef void (*symbol_func_t)(struct rspamd_task *task, gpointer user_data);
enum rspamd_symbol_type {
SYMBOL_TYPE_NORMAL = (1 << 0),
SYMBOL_TYPE_VIRTUAL = (1 << 1),
SYMBOL_TYPE_CALLBACK = (1 << 2),
SYMBOL_TYPE_GHOST = (1 << 3),
SYMBOL_TYPE_SKIPPED = (1 << 4),
SYMBOL_TYPE_COMPOSITE = (1 << 5),
SYMBOL_TYPE_FINE = (1 << 6)
};
/**
* Creates new cache structure
* @return
*/
struct symbols_cache* rspamd_symbols_cache_new (struct rspamd_config *cfg);
/**
* Remove the cache structure syncing data if needed
* @param cache
*/
void rspamd_symbols_cache_destroy (struct symbols_cache *cache);
/**
* Load symbols cache from file, must be called _after_ init_symbols_cache
*/
gboolean rspamd_symbols_cache_init (struct symbols_cache* cache);
/**
* Generic function to register a symbol
* @param cache
* @param name
* @param weight
* @param priority
* @param func
* @param user_data
* @param type
* @param parent
*/
gint rspamd_symbols_cache_add_symbol (struct symbols_cache *cache,
const gchar *name,
gint priority,
symbol_func_t func,
gpointer user_data,
enum rspamd_symbol_type type,
gint parent);
/**
* Add condition to the specific symbol in cache
* @param cache
* @param id id of symbol
* @param L lua state pointer
* @param cbref callback reference (returned by luaL_ref)
* @return TRUE if condition has been added
*/
gboolean rspamd_symbols_cache_add_condition (struct symbols_cache *cache,
gint id, lua_State *L, gint cbref);
/**
* Add delayed condition to the specific symbol in cache. So symbol can be absent
* to the moment of addition
* @param cache
* @param id id of symbol
* @param L lua state pointer
* @param cbref callback reference (returned by luaL_ref)
* @return TRUE if condition has been added
*/
gboolean rspamd_symbols_cache_add_condition_delayed (struct symbols_cache *cache,
const gchar *sym, lua_State *L, gint cbref);
/**
* Find symbol in cache by id and returns its id resolving virtual symbols if
* applicable
* @param cache
* @param name
* @return id of symbol or (-1) if a symbol has not been found
*/
gint rspamd_symbols_cache_find_symbol (struct symbols_cache *cache, const gchar *name);
/**
* Call function for cached symbol using saved callback
* @param task task object
* @param cache symbols cache
* @param saved_item pointer to currently saved item
*/
gboolean rspamd_symbols_cache_process_symbols (struct rspamd_task *task,
struct symbols_cache *cache);
/**
* Validate cache items agains theirs weights defined in metrics
* @param cache symbols cache
* @param cfg configuration
* @param strict do strict checks - symbols MUST be described in metrics
*/
gboolean rspamd_symbols_cache_validate (struct symbols_cache *cache,
struct rspamd_config *cfg,
gboolean strict);
/**
* Return statistics about the cache as ucl object (array of objects one per item)
* @param cache
* @return
*/
ucl_object_t *rspamd_symbols_cache_counters (struct symbols_cache * cache);
/**
* Start cache reloading
* @param cache
* @param ev_base
*/
void rspamd_symbols_cache_start_refresh (struct symbols_cache * cache,
struct event_base *ev_base);
/**
* Increases counter for a specific symbol
* @param cache
* @param symbol
*/
void rspamd_symbols_cache_inc_frequency (struct symbols_cache *cache,
const gchar *symbol);
/**
* Add dependency relation between two symbols identified by id (source) and
* a symbolic name (destination). Destination could be virtual or real symbol.
* Callback destinations are not yet supported.
* @param id_from source symbol
* @param to destination name
*/
void rspamd_symbols_cache_add_dependency (struct symbols_cache *cache,
gint id_from, const gchar *to);
/**
* Add delayed dependency that is resolved on cache post-load routine
* @param cache
* @param from
* @param to
*/
void rspamd_symbols_cache_add_delayed_dependency (struct symbols_cache *cache,
const gchar *from, const gchar *to);
#endif
|
