postlicyd/filter.c

   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 #include "str.h"
  37 #include "buffer.h"
  38 #include "filter.h"
  39
  40 static filter_runner_t      runners[FTK_count];
  41 static filter_constructor_t constructors[FTK_count];
  42 static filter_destructor_t  destructors[FTK_count];
  43 static bool                 hooks[FTK_count][HTK_count];
  44 static bool                 params[FTK_count][ATK_count];
  45
  46 filter_type_t filter_register(const char *type, filter_constructor_t constructor,
  47                               filter_destructor_t destructor, filter_runner_t runner)
  48 {
  49     filter_token tok = filter_tokenize(type, m_strlen(type));
  50     CHECK_FILTER(tok);
  51
  52     syslog(LOG_DEBUG, "filter type %s registered", type);
  53
  54     runners[tok] = runner;
  55     constructors[tok] = constructor;
  56     destructors[tok] = destructor;
  57     return tok;
  58 }
  59
  60 filter_result_t filter_hook_register(filter_type_t filter,
  61                                      const char *name)
  62 {
  63     filter_result_t tok = hook_tokenize(name, m_strlen(name));
  64     CHECK_FILTER(filter);
  65     CHECK_HOOK(tok);
  66
  67     syslog(LOG_DEBUG, "hook %s registered for filter type %s", name,
  68            ftokens[filter]);
  69
  70     hooks[filter][tok] = true;
  71     return tok;
  72 }
  73
  74 filter_param_id_t filter_param_register(filter_type_t filter,
  75                                         const char *name)
  76 {
  77     filter_param_id_t tok = param_tokenize(name, m_strlen(name));
  78     CHECK_FILTER(filter);
  79     CHECK_PARAM(tok);
  80
  81     syslog(LOG_INFO, "param %s registered for filter type %s", name,
  82            ftokens[filter]);
  83
  84     params[filter][tok] = true;
  85     return tok;
  86 }
  87
  88 bool filter_build(filter_t *filter)
  89 {
  90     bool ret = true;
  91     if (filter->type == FTK_UNKNOWN || filter->name == NULL) {
  92         return false;
  93     }
  94     if (filter->hooks.len > 0) {
  95 #       define QSORT_TYPE filter_hook_t
  96 #       define QSORT_BASE filter->hooks.data
  97 #       define QSORT_NELT filter->hooks.len
  98 #       define QSORT_LT(a,b) a->type < b->type
  99 #       include "qsort.c"
 100     }
 101     filter_constructor_t constructor = constructors[filter->type];
 102     if (constructor) {
 103         ret = constructor(filter);
 104     }
 105     array_deep_wipe(filter->params, filter_params_wipe);
 106     return ret;
 107 }
 108
 109 bool filter_update_references(filter_t *filter, A(filter_t) *filter_list)
 110 {
 111     foreach (filter_hook_t *hook, filter->hooks) {
 112         if (!hook->postfix) {
 113             hook->filter_id = filter_find_with_name(filter_list, hook->value);
 114             if (hook->filter_id == -1) {
 115                 syslog(LOG_ERR, "invalid filter name %s for hook %s",
 116                        hook->value, htokens[hook->type]);
 117                 return false;
 118             }
 119             p_delete(&hook->value);
 120         }
 121     }}
 122     return true;
 123 }
 124
 125 void filter_wipe(filter_t *filter)
 126 {
 127     filter_destructor_t destructor = destructors[filter->type];
 128     if (destructor) {
 129         destructor(filter);
 130     }
 131     array_deep_wipe(filter->hooks, filter_hook_wipe);
 132     array_deep_wipe(filter->params, filter_params_wipe);
 133     p_delete(&filter->name);
 134 }
 135
 136 filter_hook_t *filter_run(const filter_t *filter, const query_t *query)
 137 {
 138     int start = 0;
 139     int end   = filter->hooks.len;
 140     //syslog(LOG_DEBUG, "running filter %s (%s)",
 141     //       filter->name, ftokens[filter->type]);
 142     filter_result_t res = runners[filter->type](filter, query);
 143     //syslog(LOG_DEBUG, "filter run, result is %s", htokens[res]);
 144
 145     while (start < end) {
 146         int mid = (start + end) / 2;
 147         filter_hook_t *hook = array_ptr(filter->hooks, mid);
 148         if (hook->type == res) {
 149             //syslog(LOG_DEBUG, "return hook of type %s, value %s",
 150             //       htokens[hook->type], hook->value);
 151             return hook;
 152         } else if (res < hook->type) {
 153             end = mid;
 154         } else {
 155             start = mid + 1;
 156         }
 157     }
 158     syslog(LOG_WARNING, "missing hook %s for filter %s",
 159            htokens[res], filter->name);
 160     return NULL;
 161 }
 162
 163 void filter_set_name(filter_t *filter, const char *name, ssize_t len)
 164 {
 165     filter->name = p_new(char, len + 1);
 166     memcpy(filter->name, name, len);
 167     filter->name[len] = '\0';
 168 }
 169
 170 bool filter_set_type(filter_t *filter, const char *type, ssize_t len)
 171 {
 172     filter->type = filter_tokenize(type, len);
 173     return filter->type != FTK_UNKNOWN;
 174 }
 175
 176 bool filter_add_param(filter_t *filter, const char *name, ssize_t name_len,
 177                       const char *value, ssize_t value_len)
 178 {
 179     filter_param_t param;
 180     param.type = param_tokenize(name, name_len);
 181     if (param.type == ATK_UNKNOWN) {
 182         syslog(LOG_ERR, "unknown parameter %.*s", name_len, name);
 183         return false;
 184     }
 185     if (!params[filter->type][param.type]) {
 186         syslog(LOG_ERR, "hook %s is not valid for filter %s",
 187                atokens[param.type], ftokens[filter->type]);
 188         return false;
 189     }
 190     param.value = m_strdup(value);
 191     array_add(filter->params, param);
 192     return true;
 193 }
 194
 195 bool filter_add_hook(filter_t *filter, const char *name, ssize_t name_len,
 196                      const char *value, ssize_t value_len)
 197 {
 198     filter_hook_t hook;
 199     hook.type  = hook_tokenize(name, name_len);
 200     if (hook.type == HTK_UNKNOWN) {
 201         syslog(LOG_ERR, "unknown hook type %.*s", name_len, name);
 202         return false;
 203     }
 204     if (!hooks[filter->type][hook.type]) {
 205         syslog(LOG_ERR, "hook %s not is valid for filter %s",
 206                htokens[hook.type], ftokens[filter->type]);
 207         return false;
 208     }
 209     hook.postfix = (strncmp(value, "postfix:", 8) == 0);
 210     hook.value = m_strdup(hook.postfix ? value + 8 : value);
 211     hook.filter_id = -1;
 212     array_add(filter->hooks, hook);
 213     return true;
 214 }