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