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 const filter_hook_t default_hook = {
48 .value = (char*)"DUNNO",
53 filter_type_t filter_register(const char *type, filter_constructor_t constructor,
54 filter_destructor_t destructor, filter_runner_t runner)
56 filter_token tok = filter_tokenize(type, m_strlen(type));
59 runners[tok] = runner;
60 constructors[tok] = constructor;
61 destructors[tok] = destructor;
65 filter_result_t filter_hook_register(filter_type_t filter,
68 filter_result_t tok = hook_tokenize(name, m_strlen(name));
72 hooks[filter][tok] = true;
76 filter_param_id_t filter_param_register(filter_type_t filter,
79 filter_param_id_t tok = param_tokenize(name, m_strlen(name));
83 params[filter][tok] = true;
87 bool filter_build(filter_t *filter)
90 if (filter->type == FTK_UNKNOWN || filter->name == NULL) {
93 if (filter->hooks.len > 0) {
94 # define QSORT_TYPE filter_hook_t
95 # define QSORT_BASE filter->hooks.data
96 # define QSORT_NELT filter->hooks.len
97 # define QSORT_LT(a,b) a->type < b->type
100 filter_constructor_t constructor = constructors[filter->type];
102 ret = constructor(filter);
104 array_deep_wipe(filter->params, filter_params_wipe);
108 bool filter_update_references(filter_t *filter, A(filter_t) *filter_list)
110 foreach (filter_hook_t *hook, filter->hooks) {
111 if (!hook->postfix) {
112 hook->filter_id = filter_find_with_name(filter_list, hook->value);
113 if (hook->filter_id == -1) {
114 syslog(LOG_ERR, "invalid filter name %s for hook %s",
115 hook->value, htokens[hook->type]);
118 p_delete(&hook->value);
124 static inline bool filter_check_loop(filter_t *filter, A(filter_t) *array, int level)
126 if (filter->last_seen == level) {
129 filter->last_seen = level;
130 foreach (filter_hook_t *hook, filter->hooks) {
134 if (hook->filter_id == level) {
137 if (!filter_check_loop(array_ptr(*array, hook->filter_id), array, level)) {
144 bool filter_check_safety(A(filter_t) *array)
146 foreach (filter_t *filter, *array) {
147 if (!filter_check_loop(filter, array, __Ai)) {
148 syslog(LOG_ERR, "the filter tree contains a loop");
155 void filter_wipe(filter_t *filter)
157 filter_destructor_t destructor = destructors[filter->type];
161 array_deep_wipe(filter->hooks, filter_hook_wipe);
162 array_deep_wipe(filter->params, filter_params_wipe);
163 p_delete(&filter->name);
166 const filter_hook_t *filter_run(const filter_t *filter, const query_t *query)
169 int end = filter->hooks.len;
170 //syslog(LOG_DEBUG, "running filter %s (%s)",
171 // filter->name, ftokens[filter->type]);
172 filter_result_t res = runners[filter->type](filter, query);
174 if (res == HTK_ABORT) {
177 //syslog(LOG_DEBUG, "filter run, result is %s", htokens[res]);
179 while (start < end) {
180 int mid = (start + end) / 2;
181 filter_hook_t *hook = array_ptr(filter->hooks, mid);
182 if (hook->type == res) {
183 //syslog(LOG_DEBUG, "return hook of type %s, value %s",
184 // htokens[hook->type], hook->value);
186 } else if (res < hook->type) {
192 syslog(LOG_WARNING, "missing hook %s for filter %s",
193 htokens[res], filter->name);
194 return &default_hook;
197 bool filter_test(const filter_t *filter, const query_t *query, filter_result_t result)
199 return !!(runners[filter->type](filter, query) == result);
202 void filter_set_name(filter_t *filter, const char *name, ssize_t len)
204 filter->name = p_dupstr(name, len);
207 bool filter_set_type(filter_t *filter, const char *type, ssize_t len)
209 filter->type = filter_tokenize(type, len);
210 return filter->type != FTK_UNKNOWN;
213 bool filter_add_param(filter_t *filter, const char *name, ssize_t name_len,
214 const char *value, ssize_t value_len)
216 filter_param_t param;
217 param.type = param_tokenize(name, name_len);
218 if (param.type == ATK_UNKNOWN) {
219 syslog(LOG_ERR, "unknown parameter %.*s", name_len, name);
222 if (!params[filter->type][param.type]) {
223 syslog(LOG_ERR, "hook %s is not valid for filter %s",
224 atokens[param.type], ftokens[filter->type]);
227 param.value = p_dupstr(value, value_len);
228 param.value_len = value_len;
229 array_add(filter->params, param);
233 bool filter_add_hook(filter_t *filter, const char *name, ssize_t name_len,
234 const char *value, ssize_t value_len)
237 hook.type = hook_tokenize(name, name_len);
238 if (hook.type == HTK_UNKNOWN) {
239 syslog(LOG_ERR, "unknown hook type %.*s", name_len, name);
242 if (!hooks[filter->type][hook.type] || hook.type == HTK_ABORT) {
243 syslog(LOG_ERR, "hook %s not is valid for filter %s",
244 htokens[hook.type], ftokens[filter->type]);
247 hook.postfix = (strncmp(value, "postfix:", 8) == 0);
248 hook.value = m_strdup(hook.postfix ? value + 8 : value);
250 array_add(filter->hooks, hook);