postlicyd/filter.h

   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 #ifndef PFIXTOOLS_FILTER_H
  37 #define PFIXTOOLS_FILTER_H
  38
  39 #include "common.h"
  40 #include "filter_tokens.h"
  41 #include "hook_tokens.h"
  42 #include "param_tokens.h"
  43 #include "query.h"
  44 #include "array.h"
  45
  46 typedef filter_token filter_type_t;
  47 typedef hook_token   filter_result_t;
  48 typedef param_token  filter_param_id_t;
  49
  50 typedef struct filter_hook_t {
  51     filter_result_t type;
  52     char *value;
  53
  54     unsigned postfix:1;
  55     unsigned async:1;
  56     int filter_id;
  57 } filter_hook_t;
  58 ARRAY(filter_hook_t)
  59
  60 typedef struct filter_param_t {
  61     filter_param_id_t type;
  62     char  *value;
  63     int    value_len;
  64 } filter_param_t;
  65 ARRAY(filter_param_t)
  66
  67 /** Description of a filter.
  68  */
  69 typedef struct filter_t {
  70     char *name;
  71     filter_type_t type;
  72
  73     A(filter_hook_t)   hooks;
  74     void *data;
  75
  76     A(filter_param_t) params;
  77
  78     /* Loop checking flags.
  79      */
  80     int last_seen;
  81 } filter_t;
  82 ARRAY(filter_t)
  83
  84 /** Context of the query. To be filled with data to use when
  85  * performing asynchronous filtering.
  86  */
  87 typedef struct filter_context_t {
  88     const filter_t *current_filter;
  89     void *contexts[FTK_count];
  90
  91     void *data;
  92 } filter_context_t;
  93
  94
  95 #define FILTER_INIT { NULL, FTK_UNKNOWN, ARRAY_INIT, NULL, ARRAY_INIT, -1 }
  96 #define CHECK_FILTER(Filter)                                                   \
  97     assert(Filter != FTK_UNKNOWN && Filter != FTK_count                        \
  98            && "Unknown filter type")
  99 #define CHECK_HOOK(Hook)                                                       \
 100     assert(Hook != HTK_UNKNOWN && Hook != HTK_count                            \
 101            && "Unknown hook")
 102 #define CHECK_PARAM(Param)                                                     \
 103     assert(Param != ATK_UNKNOWN && Param != ATK_count                          \
 104            && "Unknown param")
 105
 106
 107 /* Callback to be implemented by a filter.
 108  */
 109
 110 typedef filter_result_t (*filter_runner_t)(const filter_t *filter,
 111                                            const query_t *query,
 112                                            filter_context_t *context);
 113 typedef bool (*filter_constructor_t)(filter_t *filter);
 114 typedef void (*filter_destructor_t)(filter_t *filter);
 115
 116 typedef void *(*filter_context_constructor_t)(void);
 117 typedef void (*filter_context_destructor_t)(void*);
 118
 119 typedef void (*filter_async_handler_t)(filter_context_t *context,
 120                                        const filter_hook_t *result);
 121
 122 /* Registration.
 123  */
 124
 125 __attribute__((nonnull(1,4)))
 126 filter_type_t filter_register(const char *type, filter_constructor_t constructor,
 127                               filter_destructor_t destructor, filter_runner_t runner,
 128                               filter_context_constructor_t context_constructor,
 129                               filter_context_destructor_t context_destructor);
 130
 131 __attribute__((nonnull(2)))
 132 filter_result_t filter_hook_register(filter_type_t filter, const char *name);
 133
 134 __attribute__((nonnull(2)))
 135 filter_param_id_t filter_param_register(filter_type_t filter, const char *name);
 136
 137 __attribute__((nonnull))
 138 void filter_async_handler_register(filter_async_handler_t handler);
 139
 140 /* Filter builder.
 141  */
 142
 143 __attribute__((nonnull(1)))
 144 static inline void filter_init(filter_t *filter)
 145 {
 146     const filter_t f = FILTER_INIT;
 147     *filter = f;
 148 }
 149
 150 __attribute__((nonnull(1,2)))
 151 void filter_set_name(filter_t *filter, const char *name, int len);
 152
 153 __attribute__((nonnull(1,2)))
 154 bool filter_set_type(filter_t *filter, const char *type, int len);
 155
 156 __attribute__((nonnull(1,2,4)))
 157 bool filter_add_param(filter_t *filter, const char *name, int name_len,
 158                       const char *value, int value_len);
 159
 160 __attribute__((nonnull(1,2,4)))
 161 bool filter_add_hook(filter_t *filter, const char *name, int name_len,
 162                      const char *value, int value_len);
 163
 164 __attribute__((nonnull(1)))
 165 bool filter_build(filter_t *filter);
 166
 167 __attribute__((nonnull(1,2)))
 168 static inline int filter_find_with_name(const A(filter_t) *array, const char *name)
 169 {
 170     int start = 0;
 171     int end   = array->len;
 172
 173     while (start < end) {
 174         int mid = (start + end) / 2;
 175         int cmp = strcmp(name, array_elt(*array, mid).name);
 176
 177         if (cmp == 0) {
 178             return mid;
 179         } else if (cmp < 0) {
 180             end = mid;
 181         } else {
 182             start = mid + 1;
 183         }
 184     }
 185     return -1;
 186 }
 187
 188 __attribute__((nonnull(1,2)))
 189 bool filter_update_references(filter_t *filter, A(filter_t) *array);
 190
 191 __attribute__((nonnull(1)))
 192 bool filter_check_safety(A(filter_t) *array);
 193
 194 __attribute__((nonnull(1)))
 195 static inline void filter_hook_wipe(filter_hook_t *hook)
 196 {
 197     p_delete(&hook->value);
 198 }
 199
 200 __attribute__((nonnull(1)))
 201 static inline void filter_params_wipe(filter_param_t *param)
 202 {
 203     p_delete(&param->value);
 204 }
 205
 206 __attribute__((nonnull(1)))
 207 void filter_wipe(filter_t *filter);
 208
 209
 210 /* Runner.
 211  */
 212
 213 __attribute__((nonnull(1,2)))
 214 const filter_hook_t *filter_run(const filter_t *filter, const query_t *query,
 215                                 filter_context_t *context);
 216
 217 __attribute__((nonnull(1,2)))
 218 bool filter_test(const filter_t *filter, const query_t *query,
 219                  filter_context_t *context, filter_result_t expt);
 220
 221
 222 /* Parsing Helpers
 223  */
 224
 225 #define FILTER_PARAM_PARSE_STRING(Param, Dest)                                 \
 226     case ATK_ ## Param: {                                                      \
 227         (Dest) = param->value;                                                 \
 228     } break
 229
 230 #define FILTER_PARAM_PARSE_INT(Param, Dest)                                    \
 231     case ATK_ ## Param: {                                                      \
 232         char *next;                                                            \
 233         (Dest) = strtol(param->value, &next, 10);                              \
 234         PARSE_CHECK(!*next, "invalid %s value %.*s", atokens[ATK_ ## Param],   \
 235                     param->value_len, param->value);                           \
 236      } break
 237
 238 #define FILTER_PARAM_PARSE_BOOLEAN(Param, Dest)                                \
 239     case ATK_ ## Param: {                                                      \
 240         if (param->value_len == 1 && param->value[0] == '1') {                 \
 241             (Dest) = true;                                                     \
 242         } else if (param->value_len == 1 && param->value[0] == '0') {          \
 243             (Dest) = false;                                                    \
 244         } else if (param->value_len == 4                                       \
 245                    && ascii_tolower(param->value[0]) == 't') {                 \
 246             (Dest) = ascii_tolower(param->value[1]) == 'r'                     \
 247                   && ascii_tolower(param->value[2]) == 'u'                     \
 248                   && ascii_tolower(param->value[3]) == 'e';                    \
 249         } else if (param->value_len == 5                                       \
 250                    && ascii_tolower(param->value[0]) == 'f') {                 \
 251             (Dest) = ascii_tolower(param->value[1]) == 'a'                     \
 252                   && ascii_tolower(param->value[2]) == 'l'                     \
 253                   && ascii_tolower(param->value[3]) == 's'                     \
 254                   && ascii_tolower(param->value[4]) == 'e';                    \
 255         } else {                                                               \
 256             PARSE_CHECK(false, "invalid %s value %.*s", atokens[ATK_ ## Param],\
 257                         param->value_len, param->value);                       \
 258         }                                                                      \
 259     } break
 260
 261
 262 /* Filter context
 263  */
 264
 265 __attribute__((nonnull))
 266 void filter_context_prepare(filter_context_t *context, void* qctx);
 267
 268 __attribute__((nonnull))
 269 void filter_context_wipe(filter_context_t *context);
 270
 271 __attribute__((nonnull))
 272 void filter_post_async_result(filter_context_t *context, filter_result_t result);
 273
 274 #endif