deb31902a69efb123eab3f20dc1fa36e2d06e619
[apps/pfixtools.git] / postlicyd / filter.c
1 /******************************************************************************/
2 /*          pfixtools: a collection of postfix related tools                  */
3 /*          ~~~~~~~~~                                                         */
4 /*  ________________________________________________________________________  */
5 /*                                                                            */
6 /*  Redistribution and use in source and binary forms, with or without        */
7 /*  modification, are permitted provided that the following conditions        */
8 /*  are met:                                                                  */
9 /*                                                                            */
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     */
17 /*     permission.                                                            */
18 /*                                                                            */
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 /******************************************************************************/
31
32 /*
33  * Copyright © 2008 Florent Bruneau
34  */
35
36 #include "str.h"
37 #include "buffer.h"
38 #include "filter.h"
39
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
44 void filter_register(const char *type, filter_constructor_t constructor,
45                      filter_destructor_t destructor, filter_runner_t runner)
46 {
47     filter_token tok = filter_tokenize(type, m_strlen(type));
48     assert(tok != FTK_UNKNOWN && "Unknown filter type");
49
50     syslog(LOG_INFO, "filter type %s registered", type);
51
52     runners[tok] = runner;
53     constructors[tok] = constructor;
54     destructors[tok] = destructor;
55 }
56
57 bool filter_build(filter_t *filter)
58 {
59     bool ret = true;
60     if (filter->type == FTK_UNKNOWN || filter->name == NULL) {
61         return false;
62     }
63     if (filter->hooks.len > 0) {
64 #       define QSORT_TYPE filter_hook_t
65 #       define QSORT_BASE filter->hooks.data
66 #       define QSORT_NELT filter->hooks.len
67 #       define QSORT_LT(a,b) strcmp(a->name, b->name) < 0
68 #       include "qsort.c"
69     }
70     filter_constructor_t constructor = constructors[filter->type];
71     if (constructor) {
72         ret = constructor(filter);
73     }
74     array_deep_wipe(filter->params, filter_params_wipe);
75     return ret;
76 }
77
78 bool filter_update_references(filter_t *filter, A(filter_t) *filter_list)
79 {
80     foreach (filter_hook_t *hook, filter->hooks) {
81         if (!hook->postfix) {
82             hook->filter_id = filter_find_with_name(filter_list, hook->value);
83             if (hook->filter_id == -1) {
84                 syslog(LOG_ERR, "invalid filter name %s for hook %s",
85                        hook->value, hook->name);
86                 return false;
87             }
88             p_delete(&hook->value);
89         }
90     }}
91     return true;
92 }
93
94 void filter_wipe(filter_t *filter)
95 {
96     filter_destructor_t destructor = destructors[filter->type];
97     if (destructor) {
98         destructor(filter);
99     }
100     array_deep_wipe(filter->hooks, filter_hook_wipe);
101     array_deep_wipe(filter->params, filter_params_wipe);
102     p_delete(&filter->name);
103 }
104
105 filter_result_t filter_run(const filter_t *filter, const query_t *query)
106 {
107     return runners[filter->type](filter, query);
108 }
109
110 void filter_set_name(filter_t *filter, const char *name, ssize_t len)
111 {
112     filter->name = p_new(char, len + 1);
113     memcpy(filter->name, name, len);
114     filter->name[len] = '\0';
115 }
116
117 bool filter_set_type(filter_t *filter, const char *type, ssize_t len)
118 {
119     filter->type = filter_tokenize(type, len);
120     return filter->type != FTK_UNKNOWN;
121 }
122
123 bool filter_add_param(filter_t *filter, const char *name, ssize_t name_len,
124                       const char *value, ssize_t value_len)
125 {
126     filter_params_t param;
127     param.name = m_strdup(name);
128     param.value = m_strdup(value);
129     array_add(filter->params, param);
130     return true;
131 }
132
133 bool filter_add_hook(filter_t *filter, const char *name, ssize_t name_len,
134                      const char *value, ssize_t value_len)
135 {
136     filter_hook_t hook;
137     hook.name  = m_strdup(name);
138     hook.postfix = (strncmp(value, "postfix:", 8) == 0);
139     hook.value = m_strdup(hook.postfix ? value + 8 : value);
140     hook.filter_id = -1;
141     array_add(filter->hooks, hook);
142     return true;
143 }