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 filter_type_t filter_register(const char *type, filter_constructor_t constructor,
47 filter_destructor_t destructor, filter_runner_t runner)
49 filter_token tok = filter_tokenize(type, m_strlen(type));
52 syslog(LOG_DEBUG, "filter type %s registered", type);
54 runners[tok] = runner;
55 constructors[tok] = constructor;
56 destructors[tok] = destructor;
60 filter_result_t filter_hook_register(filter_type_t filter,
63 filter_result_t tok = hook_tokenize(name, m_strlen(name));
67 syslog(LOG_DEBUG, "hook %s registered for filter type %s", name,
70 hooks[filter][tok] = true;
74 filter_param_id_t filter_param_register(filter_type_t filter,
77 filter_param_id_t tok = param_tokenize(name, m_strlen(name));
81 syslog(LOG_INFO, "param %s registered for filter type %s", name,
84 params[filter][tok] = true;
88 bool filter_build(filter_t *filter)
91 if (filter->type == FTK_UNKNOWN || filter->name == NULL) {
94 if (filter->hooks.len > 0) {
95 # define QSORT_TYPE filter_hook_t
96 # define QSORT_BASE filter->hooks.data
97 # define QSORT_NELT filter->hooks.len
98 # define QSORT_LT(a,b) a->type < b->type
101 filter_constructor_t constructor = constructors[filter->type];
103 ret = constructor(filter);
105 array_deep_wipe(filter->params, filter_params_wipe);
109 bool filter_update_references(filter_t *filter, A(filter_t) *filter_list)
111 foreach (filter_hook_t *hook, filter->hooks) {
112 if (!hook->postfix) {
113 hook->filter_id = filter_find_with_name(filter_list, hook->value);
114 if (hook->filter_id == -1) {
115 syslog(LOG_ERR, "invalid filter name %s for hook %s",
116 hook->value, htokens[hook->type]);
119 p_delete(&hook->value);
125 void filter_wipe(filter_t *filter)
127 filter_destructor_t destructor = destructors[filter->type];
131 array_deep_wipe(filter->hooks, filter_hook_wipe);
132 array_deep_wipe(filter->params, filter_params_wipe);
133 p_delete(&filter->name);
136 filter_hook_t *filter_run(const filter_t *filter, const query_t *query)
139 int end = filter->hooks.len;
140 filter_result_t res = runners[filter->type](filter, query);
142 while (start < end) {
143 int mid = (start + end) / 2;
144 filter_hook_t *hook = array_ptr(filter->hooks, mid);
145 if (hook->type == res) {
147 } else if (res < hook->type) {
153 syslog(LOG_WARNING, "missing hook %s for filter %s",
154 htokens[res], filter->name);
158 void filter_set_name(filter_t *filter, const char *name, ssize_t len)
160 filter->name = p_new(char, len + 1);
161 memcpy(filter->name, name, len);
162 filter->name[len] = '\0';
165 bool filter_set_type(filter_t *filter, const char *type, ssize_t len)
167 filter->type = filter_tokenize(type, len);
168 return filter->type != FTK_UNKNOWN;
171 bool filter_add_param(filter_t *filter, const char *name, ssize_t name_len,
172 const char *value, ssize_t value_len)
174 filter_param_t param;
175 param.type = param_tokenize(name, name_len);
176 if (param.type == ATK_UNKNOWN) {
177 syslog(LOG_ERR, "unknown parameter %.*s", name_len, name);
180 if (!params[filter->type][param.type]) {
181 syslog(LOG_ERR, "hook %s is not valid for filter %s",
182 atokens[param.type], ftokens[filter->type]);
185 param.value = m_strdup(value);
186 array_add(filter->params, param);
190 bool filter_add_hook(filter_t *filter, const char *name, ssize_t name_len,
191 const char *value, ssize_t value_len)
194 hook.type = hook_tokenize(name, name_len);
195 if (hook.type == HTK_UNKNOWN) {
196 syslog(LOG_ERR, "unknown hook type %.*s", name_len, name);
199 if (!hooks[filter->type][hook.type]) {
200 syslog(LOG_ERR, "hook %s not is valid for filter %s",
201 htokens[hook.type], ftokens[filter->type]);
204 hook.postfix = (strncmp(value, "postfix:", 8) == 0);
205 hook.value = m_strdup(hook.postfix ? value + 8 : value);
207 array_add(filter->hooks, hook);