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