1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239
|
/* Copyright (c) 2002-2013 Pigeonhole authors, see the included COPYING file
*/
#include "lib.h"
#include "hash.h"
#include "sieve-common.h"
#include "sieve-extensions.h"
#include "ext-environment-common.h"
struct ext_environment_context {
HASH_TABLE(const char *,
const struct sieve_environment_item *) environment_items;
};
/*
* Core environment items
*/
static const struct sieve_environment_item *core_env_items[] = {
&domain_env_item,
&host_env_item,
&location_env_item,
&phase_env_item,
&name_env_item,
&version_env_item
};
static unsigned int core_env_items_count = N_ELEMENTS(core_env_items);
/*
* Registration
*/
static void ext_environment_item_register
(struct ext_environment_context *ectx,
const struct sieve_environment_item *item)
{
hash_table_insert(ectx->environment_items, item->name, item);
}
void sieve_ext_environment_item_register
(const struct sieve_extension *ext, const struct sieve_environment_item *item)
{
struct ext_environment_context *ectx =
(struct ext_environment_context *) ext->context;
ext_environment_item_register(ectx, item);
}
/*
* Initialization
*/
bool ext_environment_init
(const struct sieve_extension *ext ATTR_UNUSED, void **context)
{
struct ext_environment_context *ectx =
i_new(struct ext_environment_context, 1);
unsigned int i;
hash_table_create
(&ectx->environment_items, default_pool, 0, str_hash, strcmp);
for ( i = 0; i < core_env_items_count; i++ ) {
ext_environment_item_register(ectx, core_env_items[i]);
}
*context = (void *) ectx;
return TRUE;
}
void ext_environment_deinit(const struct sieve_extension *ext)
{
struct ext_environment_context *ectx =
(struct ext_environment_context *) ext->context;
hash_table_destroy(&ectx->environment_items);
i_free(ectx);
}
/*
* Retrieval
*/
const char *ext_environment_item_get_value
(const struct sieve_extension *ext, const char *name,
const struct sieve_script_env *senv)
{
struct ext_environment_context *ectx =
(struct ext_environment_context *) ext->context;
const struct sieve_environment_item *item =
hash_table_lookup(ectx->environment_items, name);
if ( item == NULL )
return NULL;
if ( item->value != NULL )
return item->value;
if ( item->get_value != NULL )
return item->get_value(ext->svinst, senv);
return NULL;
}
/*
* Default environment items
*/
/* "domain":
*
* The primary DNS domain associated with the Sieve execution context, usually
* but not always a proper suffix of the host name.
*/
static const char *envit_domain_get_value
(struct sieve_instance *svinst,
const struct sieve_script_env *senv ATTR_UNUSED)
{
return svinst->domainname;
}
const struct sieve_environment_item domain_env_item = {
.name = "domain",
.get_value = envit_domain_get_value,
};
/* "host":
*
* The fully-qualified domain name of the host where the Sieve script is
* executing.
*/
static const char *envit_host_get_value
(struct sieve_instance *svinst,
const struct sieve_script_env *senv ATTR_UNUSED)
{
return svinst->hostname;
}
const struct sieve_environment_item host_env_item = {
.name = "host",
.get_value = envit_host_get_value,
};
/* "location":
*
* Sieve evaluation can be performed at various different points as messages
* are processed. This item provides additional information about the type of
* service that is evaluating the script. Possible values are:
* "MTA" - the Sieve script is being evaluated by a Message Transfer Agent
* "MDA" - evaluation is being performed by a Mail Delivery Agent
* "MUA" - evaluation is being performed by a Mail User Agent (right...)
* "MS" - evaluation is being performed by a Message Store
*/
static const char *envit_location_get_value
(struct sieve_instance *svinst,
const struct sieve_script_env *senv ATTR_UNUSED)
{
switch ( svinst->env_location ) {
case SIEVE_ENV_LOCATION_MDA:
return "MDA";
case SIEVE_ENV_LOCATION_MTA:
return "MTA";
case SIEVE_ENV_LOCATION_MS:
return "MS";
default:
break;
}
return NULL;
}
const struct sieve_environment_item location_env_item = {
.name = "location",
.get_value = envit_location_get_value
};
/* "phase":
*
* The point relative to final delivery where the Sieve script is being
* evaluated. Possible values are "pre", "during", and "post", referring
* respectively to processing before, during, and after final delivery has
* taken place.
*/
static const char *envit_phase_get_value
(struct sieve_instance *svinst,
const struct sieve_script_env *senv ATTR_UNUSED)
{
switch ( svinst->delivery_phase ) {
case SIEVE_DELIVERY_PHASE_PRE:
return "pre";
case SIEVE_DELIVERY_PHASE_DURING:
return "during";
case SIEVE_DELIVERY_PHASE_POST:
return "post";
default:
break;
}
return NULL;
}
const struct sieve_environment_item phase_env_item = {
.name = "phase",
.get_value = envit_phase_get_value
};
/* "name":
*
* The product name associated with the Sieve interpreter.
*/
const struct sieve_environment_item name_env_item = {
.name = "name",
.value = PIGEONHOLE_NAME" Sieve"
};
/* "version":
*
* The product version associated with the Sieve interpreter. The meaning of the
* product version string is product-specific and should always be considered
* in the context of the product name given by the "name" item.
*/
const struct sieve_environment_item version_env_item = {
.name = "version",
.value = PIGEONHOLE_VERSION,
};
|