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
  45 filter_type_t filter_register(const char *type, filter_constructor_t constructor,
  46                               filter_destructor_t destructor, filter_runner_t runner)
  47 {
  48     filter_token tok = filter_tokenize(type, m_strlen(type));
  49     CHECK_FILTER(tok);
  50
  51     syslog(LOG_INFO, "filter type %s registered", type);
  52
  53     runners[tok] = runner;
  54     constructors[tok] = constructor;
  55     destructors[tok] = destructor;
  56     return tok;
  57 }
  58
  59 filter_result_t filter_hook_register(filter_type_t filter,
  60                                      const char *name)
  61 {
  62     filter_result_t tok = hook_tokenize(name, m_strlen(name));
  63     CHECK_FILTER(filter);
  64     CHECK_HOOK(tok);
  65
  66     syslog(LOG_INFO, "hook %s registered for filter type %s", name,
  67            ftokens[filter]);
  68
  69     hooks[filter][tok] = true;
  70     return tok;
  71 }
  72
  73 bool filter_build(filter_t *filter)
  74 {
  75     bool ret = true;
  76     if (filter->type == FTK_UNKNOWN || filter->name == NULL) {
  77         return false;
  78     }
  79     if (filter->hooks.len > 0) {
  80 #       define QSORT_TYPE filter_hook_t
  81 #       define QSORT_BASE filter->hooks.data
  82 #       define QSORT_NELT filter->hooks.len
  83 #       define QSORT_LT(a,b) a->type < b->type
  84 #       include "qsort.c"
  85     }
  86     filter_constructor_t constructor = constructors[filter->type];
  87     if (constructor) {
  88         ret = constructor(filter);
  89     }
  90     array_deep_wipe(filter->params, filter_params_wipe);
  91     return ret;
  92 }
  93
  94 bool filter_update_references(filter_t *filter, A(filter_t) *filter_list)
  95 {
  96     foreach (filter_hook_t *hook, filter->hooks) {
  97         if (!hook->postfix) {
  98             hook->filter_id = filter_find_with_name(filter_list, hook->value);
  99             if (hook->filter_id == -1) {
 100                 syslog(LOG_ERR, "invalid filter name %s for hook %s",
 101                        hook->value, htokens[hook->type]);
 102                 return false;
 103             }
 104             p_delete(&hook->value);
 105         }
 106     }}
 107     return true;
 108 }
 109
 110 void filter_wipe(filter_t *filter)
 111 {
 112     filter_destructor_t destructor = destructors[filter->type];
 113     if (destructor) {
 114         destructor(filter);
 115     }
 116     array_deep_wipe(filter->hooks, filter_hook_wipe);
 117     array_deep_wipe(filter->params, filter_params_wipe);
 118     p_delete(&filter->name);
 119 }
 120
 121 filter_result_t filter_run(const filter_t *filter, const query_t *query)
 122 {
 123     return runners[filter->type](filter, query);
 124 }
 125
 126 void filter_set_name(filter_t *filter, const char *name, ssize_t len)
 127 {
 128     filter->name = p_new(char, len + 1);
 129     memcpy(filter->name, name, len);
 130     filter->name[len] = '\0';
 131 }
 132
 133 bool filter_set_type(filter_t *filter, const char *type, ssize_t len)
 134 {
 135     filter->type = filter_tokenize(type, len);
 136     return filter->type != FTK_UNKNOWN;
 137 }
 138
 139 bool filter_add_param(filter_t *filter, const char *name, ssize_t name_len,
 140                       const char *value, ssize_t value_len)
 141 {
 142     filter_params_t param;
 143     param.name = m_strdup(name);
 144     param.value = m_strdup(value);
 145     array_add(filter->params, param);
 146     return true;
 147 }
 148
 149 bool filter_add_hook(filter_t *filter, const char *name, ssize_t name_len,
 150                      const char *value, ssize_t value_len)
 151 {
 152     filter_hook_t hook;
 153     hook.type  = hook_tokenize(name, name_len);
 154     if (hook.type == HTK_UNKNOWN) {
 155         syslog(LOG_ERR, "unknown hook type %.*s", name_len, name);
 156         return false;
 157     }
 158     if (!hooks[filter->type][hook.type]) {
 159         syslog(LOG_ERR, "hook %s is valid for filter %s",
 160                htokens[hook.type], ftokens[filter->type]);
 161         return false;
 162     }
 163     hook.postfix = (strncmp(value, "postfix:", 8) == 0);
 164     hook.value = m_strdup(hook.postfix ? value + 8 : value);
 165     hook.filter_id = -1;
 166     array_add(filter->hooks, hook);
 167     return true;
 168 }