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 "query.h"
  43 #include "array.h"
  44
  45 typedef filter_token filter_type_t;
  46 typedef hook_token   filter_result_t;
  47
  48 typedef struct filter_hook_t {
  49     filter_result_t type;
  50     char *value;
  51
  52     bool postfix;
  53     int filter_id;
  54 } filter_hook_t;
  55 ARRAY(filter_hook_t)
  56
  57 typedef struct filter_params_t {
  58     char *name;
  59     char *value;
  60 } filter_params_t;
  61 ARRAY(filter_params_t)
  62
  63 typedef struct filter_t {
  64     char *name;
  65     filter_type_t type;
  66
  67     A(filter_hook_t)   hooks;
  68     void *data;
  69
  70     A(filter_params_t) params;
  71 } filter_t;
  72 ARRAY(filter_t)
  73
  74 #define FILTER_INIT { NULL, FTK_UNKNOWN, ARRAY_INIT, NULL, ARRAY_INIT }
  75 #define CHECK_FILTER(Filter)                                                   \
  76     assert(Filter != FTK_UNKNOWN && Filter != FTK_count                        \
  77            && "Unknown filter type")
  78 #define CHECK_HOOK(Hook)                                                       \
  79     assert(Hook != HTK_UNKNOWN && Hook != HTK_count                            \
  80            && "Unknown hook")
  81
  82 typedef filter_result_t (*filter_runner_t)(const filter_t *filter,
  83                                            const query_t *query);
  84 typedef bool (*filter_constructor_t)(filter_t *filter);
  85 typedef void (*filter_destructor_t)(filter_t *filter);
  86
  87 __attribute__((nonnull(1,4)))
  88 filter_type_t filter_register(const char *type, filter_constructor_t constructor,
  89                               filter_destructor_t destructor, filter_runner_t runner);
  90
  91 __attribute__((nonnull(2)))
  92 filter_result_t filter_hook_register(filter_type_t filter, const char *name);
  93
  94 __attribute__((nonnull(1)))
  95 static inline void filter_init(filter_t *filter)
  96 {
  97     const filter_t f = FILTER_INIT;
  98     *filter = f;
  99 }
 100
 101 __attribute__((nonnull(1,2)))
 102 void filter_set_name(filter_t *filter, const char *name, ssize_t len);
 103
 104 __attribute__((nonnull(1,2)))
 105 bool filter_set_type(filter_t *filter, const char *type, ssize_t len);
 106
 107 __attribute__((nonnull(1,2,4)))
 108 bool filter_add_param(filter_t *filter, const char *name, ssize_t name_len,
 109                       const char *value, ssize_t value_len);
 110
 111 __attribute__((nonnull(1,2,4)))
 112 bool filter_add_hook(filter_t *filter, const char *name, ssize_t name_len,
 113                      const char *value, ssize_t value_len);
 114
 115 __attribute__((nonnull(1)))
 116 bool filter_build(filter_t *filter);
 117
 118 __attribute__((nonnull(1,2)))
 119 static inline int filter_find_with_name(A(filter_t) *array, const char *name)
 120 {
 121     int start = 0;
 122     int end   = array->len;
 123
 124     while (start < end) {
 125         int mid = (start + end) / 2;
 126         int cmp = strcmp(name, array_elt(*array, mid).name);
 127
 128         if (cmp == 0) {
 129             return mid;
 130         } else if (cmp < 0) {
 131             end = mid;
 132         } else {
 133             start = mid + 1;
 134         }
 135     }
 136     return -1;
 137 }
 138
 139 __attribute__((nonnull(1,2)))
 140 bool filter_update_references(filter_t *filter, A(filter_t) *array);
 141
 142 __attribute__((nonnull(1)))
 143 static inline void filter_hook_wipe(filter_hook_t *hook)
 144 {
 145     p_delete(&hook->value);
 146 }
 147
 148 __attribute__((nonnull(1)))
 149 static inline void filter_params_wipe(filter_params_t *param)
 150 {
 151     p_delete(&param->name);
 152     p_delete(&param->value);
 153 }
 154
 155 __attribute__((nonnull(1)))
 156 void filter_wipe(filter_t *filter);
 157
 158 __attribute__((nonnull(1,2)))
 159 filter_result_t filter_run(const filter_t *filter, const query_t *query);
 160
 161
 162 #endif