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     bool postfix;
  55     int filter_id;
  56 } filter_hook_t;
  57 ARRAY(filter_hook_t)
  58
  59 typedef struct filter_param_t {
  60     filter_param_id_t type;
  61     char  *value;
  62     int    value_len;
  63 } filter_param_t;
  64 ARRAY(filter_param_t)
  65
  66 typedef struct filter_t {
  67     char *name;
  68     filter_type_t type;
  69
  70     A(filter_hook_t)   hooks;
  71     void *data;
  72
  73     A(filter_param_t) params;
  74
  75     /* Loop checking flags.
  76      */
  77     int last_seen;
  78 } filter_t;
  79 ARRAY(filter_t)
  80
  81 #define FILTER_INIT { NULL, FTK_UNKNOWN, ARRAY_INIT, NULL, ARRAY_INIT, -1 }
  82 #define CHECK_FILTER(Filter)                                                   \
  83     assert(Filter != FTK_UNKNOWN && Filter != FTK_count                        \
  84            && "Unknown filter type")
  85 #define CHECK_HOOK(Hook)                                                       \
  86     assert(Hook != HTK_UNKNOWN && Hook != HTK_count                            \
  87            && "Unknown hook")
  88 #define CHECK_PARAM(Param)                                                     \
  89     assert(Param != ATK_UNKNOWN && Param != ATK_count                          \
  90            && "Unknown param")
  91
  92 typedef filter_result_t (*filter_runner_t)(const filter_t *filter,
  93                                            const query_t *query);
  94 typedef bool (*filter_constructor_t)(filter_t *filter);
  95 typedef void (*filter_destructor_t)(filter_t *filter);
  96
  97 __attribute__((nonnull(1,4)))
  98 filter_type_t filter_register(const char *type, filter_constructor_t constructor,
  99                               filter_destructor_t destructor, filter_runner_t runner);
 100
 101 __attribute__((nonnull(2)))
 102 filter_result_t filter_hook_register(filter_type_t filter, const char *name);
 103
 104 __attribute__((nonnull(2)))
 105 filter_param_id_t filter_param_register(filter_type_t filter, const char *name);
 106
 107 __attribute__((nonnull(1)))
 108 static inline void filter_init(filter_t *filter)
 109 {
 110     const filter_t f = FILTER_INIT;
 111     *filter = f;
 112 }
 113
 114 __attribute__((nonnull(1,2)))
 115 void filter_set_name(filter_t *filter, const char *name, int len);
 116
 117 __attribute__((nonnull(1,2)))
 118 bool filter_set_type(filter_t *filter, const char *type, int len);
 119
 120 __attribute__((nonnull(1,2,4)))
 121 bool filter_add_param(filter_t *filter, const char *name, int name_len,
 122                       const char *value, int value_len);
 123
 124 __attribute__((nonnull(1,2,4)))
 125 bool filter_add_hook(filter_t *filter, const char *name, int name_len,
 126                      const char *value, int value_len);
 127
 128 __attribute__((nonnull(1)))
 129 bool filter_build(filter_t *filter);
 130
 131 __attribute__((nonnull(1,2)))
 132 static inline int filter_find_with_name(const A(filter_t) *array, const char *name)
 133 {
 134     int start = 0;
 135     int end   = array->len;
 136
 137     while (start < end) {
 138         int mid = (start + end) / 2;
 139         int cmp = strcmp(name, array_elt(*array, mid).name);
 140
 141         if (cmp == 0) {
 142             return mid;
 143         } else if (cmp < 0) {
 144             end = mid;
 145         } else {
 146             start = mid + 1;
 147         }
 148     }
 149     return -1;
 150 }
 151
 152 __attribute__((nonnull(1,2)))
 153 bool filter_update_references(filter_t *filter, A(filter_t) *array);
 154
 155 __attribute__((nonnull(1)))
 156 bool filter_check_safety(A(filter_t) *array);
 157
 158 __attribute__((nonnull(1)))
 159 static inline void filter_hook_wipe(filter_hook_t *hook)
 160 {
 161     p_delete(&hook->value);
 162 }
 163
 164 __attribute__((nonnull(1)))
 165 static inline void filter_params_wipe(filter_param_t *param)
 166 {
 167     p_delete(&param->value);
 168 }
 169
 170 __attribute__((nonnull(1)))
 171 void filter_wipe(filter_t *filter);
 172
 173 __attribute__((nonnull(1,2)))
 174 const filter_hook_t *filter_run(const filter_t *filter, const query_t *query);
 175
 176 __attribute__((nonnull(1,2)))
 177 bool filter_test(const filter_t *filter, const query_t *query, filter_result_t expt);
 178
 179
 180 /* Helpers
 181  */
 182
 183 #define FILTER_PARAM_PARSE_STRING(Param, Dest)                                 \
 184     case ATK_ ## Param: {                                                      \
 185         (Dest) = param->value;                                                 \
 186     } break
 187
 188 #define FILTER_PARAM_PARSE_INT(Param, Dest)                                    \
 189     case ATK_ ## Param: {                                                      \
 190         char *next;                                                            \
 191         (Dest) = strtol(param->value, &next, 10);                              \
 192         PARSE_CHECK(!*next, "invalid %s value %.*s", atokens[ATK_ ## Param],   \
 193                     param->value_len, param->value);                           \
 194      } break
 195
 196 #define FILTER_PARAM_PARSE_BOOLEAN(Param, Dest)                                \
 197     case ATK_ ## Param: {                                                      \
 198         if (param->value_len == 1 && param->value[0] == '1') {                 \
 199             (Dest) = true;                                                     \
 200         } else if (param->value_len == 1 && param->value[0] == '0') {          \
 201             (Dest) = false;                                                    \
 202         } else if (param->value_len == 4                                       \
 203                    && ascii_tolower(param->value[0]) == 't') {                 \
 204             (Dest) = ascii_tolower(param->value[1]) == 'r'                     \
 205                   && ascii_tolower(param->value[2]) == 'u'                     \
 206                   && ascii_tolower(param->value[3]) == 'e';                    \
 207         } else if (param->value_len == 5                                       \
 208                    && ascii_tolower(param->value[0]) == 'f') {                 \
 209             (Dest) = ascii_tolower(param->value[1]) == 'a'                     \
 210                   && ascii_tolower(param->value[2]) == 'l'                     \
 211                   && ascii_tolower(param->value[3]) == 's'                     \
 212                   && ascii_tolower(param->value[4]) == 'e';                    \
 213         } else {                                                               \
 214             PARSE_CHECK(false, "invalid %s value %.*s", atokens[ATK_ ## Param],\
 215                         param->value_len, param->value);                       \
 216         }                                                                      \
 217     } break
 218
 219 #endif