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 syslog(LOG_DEBUG, "filter type %s registered", type);
61 runners[tok] = runner;
62 constructors[tok] = constructor;
63 destructors[tok] = destructor;
67 filter_result_t filter_hook_register(filter_type_t filter,
70 filter_result_t tok = hook_tokenize(name, m_strlen(name));
74 syslog(LOG_DEBUG, "hook %s registered for filter type %s", name,
77 hooks[filter][tok] = true;
81 filter_param_id_t filter_param_register(filter_type_t filter,
84 filter_param_id_t tok = param_tokenize(name, m_strlen(name));
88 syslog(LOG_INFO, "param %s registered for filter type %s", name,
91 params[filter][tok] = true;
95 bool filter_build(filter_t *filter)
98 if (filter->type == FTK_UNKNOWN || filter->name == NULL) {
101 if (filter->hooks.len > 0) {
102 # define QSORT_TYPE filter_hook_t
103 # define QSORT_BASE filter->hooks.data
104 # define QSORT_NELT filter->hooks.len
105 # define QSORT_LT(a,b) a->type < b->type
108 filter_constructor_t constructor = constructors[filter->type];
110 ret = constructor(filter);
112 array_deep_wipe(filter->params, filter_params_wipe);
116 bool filter_update_references(filter_t *filter, A(filter_t) *filter_list)
118 foreach (filter_hook_t *hook, filter->hooks) {
119 if (!hook->postfix) {
120 hook->filter_id = filter_find_with_name(filter_list, hook->value);
121 if (hook->filter_id == -1) {
122 syslog(LOG_ERR, "invalid filter name %s for hook %s",
123 hook->value, htokens[hook->type]);
126 p_delete(&hook->value);
132 static inline bool filter_check_loop(filter_t *filter, A(filter_t) *array, bool cleanup)
135 foreach (filter_t *filter2, *array) {
136 filter2->seen = false;
138 } else if (filter->seen) {
145 foreach (filter_hook_t *hook, filter->hooks) {
149 if (!filter_check_loop(array_ptr(*array, hook->filter_id), array, false)) {
157 bool filter_check_safety(A(filter_t) *array)
159 foreach (filter_t *filter, *array) {
160 if (!filter_check_loop(filter, array, true)) {
161 syslog(LOG_ERR, "the filter tree contains a loop");
168 void filter_wipe(filter_t *filter)
170 filter_destructor_t destructor = destructors[filter->type];
174 array_deep_wipe(filter->hooks, filter_hook_wipe);
175 array_deep_wipe(filter->params, filter_params_wipe);
176 p_delete(&filter->name);
179 const filter_hook_t *filter_run(const filter_t *filter, const query_t *query)
182 int end = filter->hooks.len;
183 //syslog(LOG_DEBUG, "running filter %s (%s)",
184 // filter->name, ftokens[filter->type]);
185 filter_result_t res = runners[filter->type](filter, query);
187 if (res == HTK_ABORT) {
190 //syslog(LOG_DEBUG, "filter run, result is %s", htokens[res]);
192 while (start < end) {
193 int mid = (start + end) / 2;
194 filter_hook_t *hook = array_ptr(filter->hooks, mid);
195 if (hook->type == res) {
196 //syslog(LOG_DEBUG, "return hook of type %s, value %s",
197 // htokens[hook->type], hook->value);
199 } else if (res < hook->type) {
205 syslog(LOG_WARNING, "missing hook %s for filter %s",
206 htokens[res], filter->name);
207 return &default_hook;
210 void filter_set_name(filter_t *filter, const char *name, ssize_t len)
212 filter->name = p_new(char, len + 1);
213 memcpy(filter->name, name, len);
214 filter->name[len] = '\0';
217 bool filter_set_type(filter_t *filter, const char *type, ssize_t len)
219 filter->type = filter_tokenize(type, len);
220 return filter->type != FTK_UNKNOWN;
223 bool filter_add_param(filter_t *filter, const char *name, ssize_t name_len,
224 const char *value, ssize_t value_len)
226 filter_param_t param;
227 param.type = param_tokenize(name, name_len);
228 if (param.type == ATK_UNKNOWN) {
229 syslog(LOG_ERR, "unknown parameter %.*s", name_len, name);
232 if (!params[filter->type][param.type]) {
233 syslog(LOG_ERR, "hook %s is not valid for filter %s",
234 atokens[param.type], ftokens[filter->type]);
237 param.value = m_strdup(value);
238 array_add(filter->params, param);
242 bool filter_add_hook(filter_t *filter, const char *name, ssize_t name_len,
243 const char *value, ssize_t value_len)
246 hook.type = hook_tokenize(name, name_len);
247 if (hook.type == HTK_UNKNOWN) {
248 syslog(LOG_ERR, "unknown hook type %.*s", name_len, name);
251 if (!hooks[filter->type][hook.type] || hook.type == HTK_ABORT) {
252 syslog(LOG_ERR, "hook %s not is valid for filter %s",
253 htokens[hook.type], ftokens[filter->type]);
256 hook.postfix = (strncmp(value, "postfix:", 8) == 0);
257 hook.value = m_strdup(hook.postfix ? value + 8 : value);
259 array_add(filter->hooks, hook);