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",
58 static const filter_hook_t async_hook = {
66 uint32_t filter_running = 0;
68 filter_type_t filter_register(const char *type, filter_constructor_t constructor,
69 filter_destructor_t destructor, filter_runner_t runner,
70 filter_context_constructor_t context_constructor,
71 filter_context_destructor_t context_destructor)
73 filter_token tok = filter_tokenize(type, m_strlen(type));
76 runners[tok] = runner;
77 constructors[tok] = constructor;
78 destructors[tok] = destructor;
80 ctx_constructors[tok] = context_constructor;
81 ctx_destructors[tok] = context_destructor;
85 filter_result_t filter_hook_register(filter_type_t filter,
88 filter_result_t tok = hook_tokenize(name, m_strlen(name));
92 hooks[filter][tok] = true;
96 filter_param_id_t filter_param_register(filter_type_t filter,
99 filter_param_id_t tok = param_tokenize(name, m_strlen(name));
100 CHECK_FILTER(filter);
103 params[filter][tok] = true;
107 void filter_async_handler_register(filter_async_handler_t handler)
109 async_handler = handler;
112 bool filter_build(filter_t *filter)
115 if (filter->type == FTK_UNKNOWN || filter->name == NULL) {
118 if (filter->hooks.len > 0) {
119 # define QSORT_TYPE filter_hook_t
120 # define QSORT_BASE filter->hooks.data
121 # define QSORT_NELT filter->hooks.len
122 # define QSORT_LT(a,b) a->type < b->type
125 filter_constructor_t constructor = constructors[filter->type];
127 ret = constructor(filter);
129 array_deep_wipe(filter->params, filter_params_wipe);
133 bool filter_update_references(filter_t *filter, A(filter_t) *filter_list)
135 foreach (filter_hook_t *hook, filter->hooks) {
136 if (!hook->postfix) {
137 hook->filter_id = filter_find_with_name(filter_list, hook->value);
138 if (hook->filter_id == -1) {
139 err("invalid filter name %s for hook %s",
140 hook->value, htokens[hook->type]);
143 p_delete(&hook->value);
149 static inline bool filter_check_loop(filter_t *filter, A(filter_t) *array, int level)
151 if (filter->last_seen == level) {
154 filter->last_seen = level;
155 foreach (filter_hook_t *hook, filter->hooks) {
159 if (hook->filter_id == level) {
162 if (!filter_check_loop(array_ptr(*array, hook->filter_id), array, level)) {
169 bool filter_check_safety(A(filter_t) *array)
171 foreach (filter_t *filter, *array) {
172 if (!filter_check_loop(filter, array, __Ai)) {
173 err("the filter tree contains a loop");
180 void filter_wipe(filter_t *filter)
182 filter_destructor_t destructor = destructors[filter->type];
186 array_deep_wipe(filter->hooks, filter_hook_wipe);
187 array_deep_wipe(filter->params, filter_params_wipe);
188 p_delete(&filter->name);
191 static inline const filter_hook_t *filter_hook_for_result(const filter_t *filter,
195 int end = filter->hooks.len;
197 if (res == HTK_ABORT) {
200 if (res == HTK_ASYNC) {
204 while (start < end) {
205 int mid = (start + end) / 2;
206 filter_hook_t *hook = array_ptr(filter->hooks, mid);
207 if (hook->type == res) {
208 debug("return hook of type %s, value %s",
209 htokens[hook->type], hook->value);
211 } else if (res < hook->type) {
217 warn("missing hook %s for filter %s", htokens[res], filter->name);
218 return &default_hook;
221 const filter_hook_t *filter_run(const filter_t *filter, const query_t *query,
222 filter_context_t *context)
224 debug("running filter %s (%s)", filter->name, ftokens[filter->type]);
226 filter_result_t res = runners[filter->type](filter, query, context);
228 if (res == HTK_ASYNC) {
229 context->current_filter = filter;
232 context->current_filter = NULL;
235 debug("filter run, result is %s", htokens[res]);
236 return filter_hook_for_result(filter, res);
239 bool filter_test(const filter_t *filter, const query_t *query,
240 filter_context_t *context, filter_result_t result)
242 return !!(runners[filter->type](filter, query, context) == result);
245 void filter_set_name(filter_t *filter, const char *name, int len)
247 filter->name = p_dupstr(name, len);
250 bool filter_set_type(filter_t *filter, const char *type, int len)
252 filter->type = filter_tokenize(type, len);
253 return filter->type != FTK_UNKNOWN;
256 bool filter_add_param(filter_t *filter, const char *name, int name_len,
257 const char *value, int value_len)
259 filter_param_t param;
260 param.type = param_tokenize(name, name_len);
261 if (param.type == ATK_UNKNOWN) {
262 err("unknown parameter %.*s", name_len, name);
265 if (!params[filter->type][param.type]) {
266 err("hook %s is not valid for filter %s",
267 atokens[param.type], ftokens[filter->type]);
270 param.value = p_dupstr(value, value_len);
271 param.value_len = value_len;
272 array_add(filter->params, param);
276 bool filter_add_hook(filter_t *filter, const char *name, int name_len,
277 const char *value, int value_len)
280 hook.type = hook_tokenize(name, name_len);
281 if (hook.type == HTK_UNKNOWN) {
282 err("unknown hook type %.*s", name_len, name);
285 if (!hooks[filter->type][hook.type] || hook.type == HTK_ABORT) {
286 err("hook %s not is valid for filter %s",
287 htokens[hook.type], ftokens[filter->type]);
293 hook.postfix = (strncmp(value, "postfix:", 8) == 0);
294 if (hook.postfix && query_format(NULL, 0, value + 8, NULL) == -1) {
295 err("invalid formatted text \"%s\"", value + 8);
298 hook.value = m_strdup(hook.postfix ? value + 8 : value);
299 array_add(filter->hooks, hook);
303 void filter_context_prepare(filter_context_t *context, void *qctx)
305 for (int i = 0 ; i < FTK_count ; ++i) {
306 if (ctx_constructors[i] != NULL) {
307 context->contexts[i] = ctx_constructors[i]();
310 context->current_filter = NULL;
311 context->data = qctx;
314 void filter_context_wipe(filter_context_t *context)
316 for (int i = 0 ; i < FTK_count ; ++i) {
317 if (ctx_destructors[i] != NULL) {
318 ctx_destructors[i](context->contexts[i]);
323 void filter_post_async_result(filter_context_t *context, filter_result_t result)
325 const filter_t *filter = context->current_filter;
326 const filter_hook_t *hook = NULL;
328 if (result == HTK_ASYNC) {
332 hook = filter_hook_for_result(filter, result);
333 async_handler(context, hook);