1 /******************************************************************************/
2 /* pfixtools: a collection of postfix related tools */
4 /* ________________________________________________________________________ */
6 /* Redistribution and use in source and binary forms, with or without */
7 /* modification, are permitted provided that the following conditions */
10 /* 1. Redistributions of source code must retain the above copyright */
11 /* notice, this list of conditions and the following disclaimer. */
12 /* 2. Redistributions in binary form must reproduce the above copyright */
13 /* notice, this list of conditions and the following disclaimer in the */
14 /* documentation and/or other materials provided with the distribution. */
15 /* 3. The names of its contributors may not be used to endorse or promote */
16 /* products derived from this software without specific prior written */
19 /* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND */
20 /* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE */
21 /* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR */
22 /* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS */
23 /* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR */
24 /* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF */
25 /* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS */
26 /* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN */
27 /* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) */
28 /* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF */
29 /* THE POSSIBILITY OF SUCH DAMAGE. */
30 /******************************************************************************/
33 * Copyright © 2008 Florent Bruneau
40 static filter_runner_t runners[FTK_count];
41 static filter_constructor_t constructors[FTK_count];
42 static filter_destructor_t destructors[FTK_count];
43 static bool hooks[FTK_count][HTK_count];
44 static bool params[FTK_count][ATK_count];
46 static filter_context_constructor_t ctx_constructors[FTK_count];
47 static filter_context_destructor_t ctx_destructors[FTK_count];
48 static filter_async_handler_t async_handler = NULL;
50 static const filter_hook_t default_hook = {
52 .value = (char*)"DUNNO",
60 static const filter_hook_t async_hook = {
70 uint32_t filter_running = 0;
72 filter_type_t filter_register(const char *type, filter_constructor_t constructor,
73 filter_destructor_t destructor, filter_runner_t runner,
74 filter_context_constructor_t context_constructor,
75 filter_context_destructor_t context_destructor)
77 filter_token tok = filter_tokenize(type, m_strlen(type));
80 runners[tok] = runner;
81 constructors[tok] = constructor;
82 destructors[tok] = destructor;
84 ctx_constructors[tok] = context_constructor;
85 ctx_destructors[tok] = context_destructor;
89 filter_result_t filter_hook_register(filter_type_t filter,
92 filter_result_t tok = hook_tokenize(name, m_strlen(name));
96 hooks[filter][tok] = true;
100 filter_param_id_t filter_param_register(filter_type_t filter,
103 filter_param_id_t tok = param_tokenize(name, m_strlen(name));
104 CHECK_FILTER(filter);
107 params[filter][tok] = true;
111 void filter_async_handler_register(filter_async_handler_t handler)
113 async_handler = handler;
116 bool filter_build(filter_t *filter)
119 if (filter->type == FTK_UNKNOWN || filter->name == NULL) {
122 if (filter->hooks.len > 0) {
123 # define QSORT_TYPE filter_hook_t
124 # define QSORT_BASE filter->hooks.data
125 # define QSORT_NELT filter->hooks.len
126 # define QSORT_LT(a,b) a->type < b->type
129 filter_constructor_t constructor = constructors[filter->type];
131 ret = constructor(filter);
133 array_deep_wipe(filter->params, filter_params_wipe);
137 bool filter_update_references(filter_t *filter, A(filter_t) *filter_list)
139 foreach (filter_hook_t *hook, filter->hooks) {
140 if (!hook->postfix) {
141 hook->filter_id = filter_find_with_name(filter_list, hook->value);
142 if (hook->filter_id == -1) {
143 err("invalid filter name %s for hook %s",
144 hook->value, htokens[hook->type]);
147 p_delete(&hook->value);
153 static inline bool filter_check_loop(filter_t *filter, A(filter_t) *array, int level)
155 if (filter->last_seen == level) {
158 filter->last_seen = level;
159 foreach (filter_hook_t *hook, filter->hooks) {
163 if (hook->filter_id == level) {
166 if (!filter_check_loop(array_ptr(*array, hook->filter_id), array, level)) {
173 bool filter_check_safety(A(filter_t) *array)
175 foreach (filter_t *filter, *array) {
176 if (!filter_check_loop(filter, array, __Ai)) {
177 err("the filter tree contains a loop");
184 void filter_wipe(filter_t *filter)
186 filter_destructor_t destructor = destructors[filter->type];
190 array_deep_wipe(filter->hooks, filter_hook_wipe);
191 array_deep_wipe(filter->params, filter_params_wipe);
192 p_delete(&filter->name);
195 static inline const filter_hook_t *filter_hook_for_result(const filter_t *filter,
199 int end = filter->hooks.len;
201 if (res == HTK_ABORT) {
204 if (res == HTK_ASYNC) {
208 while (start < end) {
209 int mid = (start + end) / 2;
210 filter_hook_t *hook = array_ptr(filter->hooks, mid);
211 if (hook->type == res) {
212 debug("return hook of type %s, value %s",
213 htokens[hook->type], hook->value);
215 } else if (res < hook->type) {
221 warn("missing hook %s for filter %s", htokens[res], filter->name);
222 return &default_hook;
225 const filter_hook_t *filter_run(const filter_t *filter, const query_t *query,
226 filter_context_t *context)
228 debug("running filter %s (%s)", filter->name, ftokens[filter->type]);
230 filter_result_t res = runners[filter->type](filter, query, context);
232 if (res == HTK_ASYNC) {
233 context->current_filter = filter;
236 context->current_filter = NULL;
239 debug("filter run, result is %s", htokens[res]);
240 return filter_hook_for_result(filter, res);
243 bool filter_test(const filter_t *filter, const query_t *query,
244 filter_context_t *context, filter_result_t result)
246 return !!(runners[filter->type](filter, query, context) == result);
249 void filter_set_name(filter_t *filter, const char *name, int len)
251 filter->name = p_dupstr(name, len);
254 bool filter_set_type(filter_t *filter, const char *type, int len)
256 filter->type = filter_tokenize(type, len);
257 return filter->type != FTK_UNKNOWN;
260 bool filter_add_param(filter_t *filter, const char *name, int name_len,
261 const char *value, int value_len)
263 filter_param_t param;
264 param.type = param_tokenize(name, name_len);
265 if (param.type == ATK_UNKNOWN) {
266 err("unknown parameter %.*s", name_len, name);
269 if (!params[filter->type][param.type]) {
270 err("hook %s is not valid for filter %s",
271 atokens[param.type], ftokens[filter->type]);
274 param.value = p_dupstr(value, value_len);
275 param.value_len = value_len;
276 array_add(filter->params, param);
280 bool filter_add_hook(filter_t *filter, const char *name, int name_len,
281 const char *value, int value_len)
284 hook.type = hook_tokenize(name, name_len);
285 if (hook.type == HTK_UNKNOWN) {
286 err("unknown hook type %.*s", name_len, name);
289 if (!hooks[filter->type][hook.type] || hook.type == HTK_ABORT) {
290 err("hook %s not is valid for filter %s",
291 htokens[hook.type], ftokens[filter->type]);
296 /* Value format is (counter:id:incr)?(postfix:reply|filter_name)
298 if (strncmp(value, "counter:", 8) == 0) {
301 hook.counter = strtol(value, &end, 10);
302 if (end == value || *end != ':') {
303 err("hook %s, cannot read counter id", htokens[hook.type]);
305 } else if (hook.counter < 0 || hook.counter >= MAX_COUNTERS) {
306 err("hook %s, invalid counter id %d", htokens[hook.type], hook.counter);
310 hook.cost = strtol(value, &end, 10);
311 if (end == value || *end != ':') {
312 err("hook %s, cannot read counter increment", htokens[hook.type]);
314 } else if (hook.cost < 0) {
315 err("hook %s, invalid counter increment value %d", htokens[hook.type],
324 hook.postfix = (strncmp(value, "postfix:", 8) == 0);
325 if (hook.postfix && query_format(NULL, 0, value + 8, NULL) == -1) {
326 err("invalid formatted text \"%s\"", value + 8);
329 hook.value = m_strdup(hook.postfix ? value + 8 : value);
331 array_add(filter->hooks, hook);
335 void filter_context_prepare(filter_context_t *context, void *qctx)
337 for (int i = 0 ; i < FTK_count ; ++i) {
338 if (ctx_constructors[i] != NULL) {
339 context->contexts[i] = ctx_constructors[i]();
342 context->current_filter = NULL;
343 context->data = qctx;
346 void filter_context_wipe(filter_context_t *context)
348 for (int i = 0 ; i < FTK_count ; ++i) {
349 if (ctx_destructors[i] != NULL) {
350 ctx_destructors[i](context->contexts[i]);
355 void filter_context_clean(filter_context_t *context)
357 p_clear(&context->counters, 1);
358 context->instance[0] = '\0';
361 void filter_post_async_result(filter_context_t *context, filter_result_t result)
363 const filter_t *filter = context->current_filter;
364 const filter_hook_t *hook = NULL;
366 if (result == HTK_ASYNC) {
370 hook = filter_hook_for_result(filter, result);
371 async_handler(context, hook);