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 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431
|
/* Copyright (c) 2002-2010 Dovecot Sieve authors, see the included COPYING file
*/
#include "lib.h"
#include "str.h"
#include "sieve-common.h"
#include "sieve-error.h"
#include "sieve-script.h"
#include "sieve-binary.h"
#include "sieve-generator.h"
#include "sieve-interpreter.h"
#include "sieve-dump.h"
#include "sieve-ext-variables.h"
#include "ext-include-common.h"
#include "ext-include-limits.h"
#include "ext-include-variables.h"
#include "ext-include-binary.h"
/*
* Forward declarations
*/
static bool ext_include_binary_save
(const struct sieve_extension *ext, struct sieve_binary *sbin, void *context);
static bool ext_include_binary_open
(const struct sieve_extension *ext, struct sieve_binary *sbin, void *context);
static bool ext_include_binary_up_to_date
(const struct sieve_extension *ext, struct sieve_binary *sbin, void *context);
static void ext_include_binary_free
(const struct sieve_extension *ext, struct sieve_binary *sbin, void *context);
/*
* Binary include extension
*/
const struct sieve_binary_extension include_binary_ext = {
&include_extension,
ext_include_binary_save,
ext_include_binary_open,
ext_include_binary_free,
ext_include_binary_up_to_date
};
/*
* Binary context management
*/
struct ext_include_binary_context {
struct sieve_binary *binary;
unsigned int dependency_block;
struct hash_table *included_scripts;
ARRAY_DEFINE(include_index, struct ext_include_script_info *);
struct sieve_variable_scope *global_vars;
};
static struct ext_include_binary_context *ext_include_binary_create_context
(const struct sieve_extension *this_ext, struct sieve_binary *sbin)
{
pool_t pool = sieve_binary_pool(sbin);
struct ext_include_binary_context *ctx =
p_new(pool, struct ext_include_binary_context, 1);
ctx->binary = sbin;
ctx->included_scripts = hash_table_create(default_pool, pool, 0,
(hash_callback_t *) sieve_script_hash,
(hash_cmp_callback_t *) sieve_script_cmp);
p_array_init(&ctx->include_index, pool, 128);
sieve_binary_extension_set(sbin, this_ext, &include_binary_ext, ctx);
return ctx;
}
struct ext_include_binary_context *ext_include_binary_get_context
(const struct sieve_extension *this_ext, struct sieve_binary *sbin)
{
struct ext_include_binary_context *ctx = (struct ext_include_binary_context *)
sieve_binary_extension_get_context(sbin, this_ext);
if ( ctx == NULL )
ctx = ext_include_binary_create_context(this_ext, sbin);
return ctx;
}
struct ext_include_binary_context *ext_include_binary_init
(const struct sieve_extension *this_ext, struct sieve_binary *sbin,
struct sieve_ast *ast)
{
struct ext_include_ast_context *ast_ctx =
ext_include_get_ast_context(this_ext, ast);
struct ext_include_binary_context *ctx;
/* Get/create our context from the binary we are working on */
ctx = ext_include_binary_get_context(this_ext, sbin);
/* Create dependency block */
if ( ctx->dependency_block == 0 )
ctx->dependency_block =
sieve_binary_extension_create_block(sbin, this_ext);
if ( ctx->global_vars == NULL ) {
ctx->global_vars = ast_ctx->global_vars;
sieve_variable_scope_ref(ctx->global_vars);
}
return ctx;
}
/*
* Script inclusion
*/
const struct ext_include_script_info *ext_include_binary_script_include
(struct ext_include_binary_context *binctx, struct sieve_script *script,
enum ext_include_script_location location, unsigned int block_id)
{
pool_t pool = sieve_binary_pool(binctx->binary);
struct ext_include_script_info *incscript;
incscript = p_new(pool, struct ext_include_script_info, 1);
incscript->id = array_count(&binctx->include_index)+1;
incscript->script = script;
incscript->location = location;
incscript->block_id = block_id;
/* Unreferenced on binary_free */
sieve_script_ref(script);
hash_table_insert
(binctx->included_scripts, (void *) script, (void *) incscript);
array_append(&binctx->include_index, &incscript, 1);
return incscript;
}
bool ext_include_binary_script_is_included
(struct ext_include_binary_context *binctx, struct sieve_script *script,
const struct ext_include_script_info **script_info_r)
{
struct ext_include_script_info *incscript = (struct ext_include_script_info *)
hash_table_lookup(binctx->included_scripts, script);
if ( incscript == NULL )
return FALSE;
*script_info_r = incscript;
return TRUE;
}
const struct ext_include_script_info *ext_include_binary_script_get_included
(struct ext_include_binary_context *binctx, unsigned int include_id)
{
if ( include_id > 0 &&
(include_id - 1) < array_count(&binctx->include_index) ) {
struct ext_include_script_info *const *sinfo =
array_idx(&binctx->include_index, include_id - 1);
return *sinfo;
}
return NULL;
}
const struct ext_include_script_info *ext_include_binary_script_get
(struct ext_include_binary_context *binctx, struct sieve_script *script)
{
return (struct ext_include_script_info *)
hash_table_lookup(binctx->included_scripts, script);
}
unsigned int ext_include_binary_script_get_count
(struct ext_include_binary_context *binctx)
{
return array_count(&binctx->include_index);
}
/*
* Variables
*/
struct sieve_variable_scope *ext_include_binary_get_global_scope
(const struct sieve_extension *this_ext, struct sieve_binary *sbin)
{
struct ext_include_binary_context *binctx =
ext_include_binary_get_context(this_ext, sbin);
return binctx->global_vars;
}
/*
* Binary extension
*/
static bool ext_include_binary_save
(const struct sieve_extension *ext ATTR_UNUSED, struct sieve_binary *sbin,
void *context)
{
struct ext_include_binary_context *binctx =
(struct ext_include_binary_context *) context;
struct ext_include_script_info *const *scripts;
unsigned int script_count, i;
unsigned int prvblk;
bool result = TRUE;
sieve_binary_block_clear(sbin, binctx->dependency_block);
if ( !sieve_binary_block_set_active(sbin, binctx->dependency_block, &prvblk) )
return FALSE;
scripts = array_get(&binctx->include_index, &script_count);
sieve_binary_emit_unsigned(sbin, script_count);
for ( i = 0; i < script_count; i++ ) {
struct ext_include_script_info *incscript = scripts[i];
sieve_binary_emit_unsigned(sbin, incscript->block_id);
sieve_binary_emit_byte(sbin, incscript->location);
sieve_binary_emit_cstring(sbin, sieve_script_name(incscript->script));
}
result = ext_include_variables_save(sbin, binctx->global_vars);
(void) sieve_binary_block_set_active(sbin, prvblk, NULL);
return result;
}
static bool ext_include_binary_open
(const struct sieve_extension *ext, struct sieve_binary *sbin, void *context)
{
struct ext_include_binary_context *binctx =
(struct ext_include_binary_context *) context;
unsigned int block, prvblk, depcount, i;
sieve_size_t offset;
block = sieve_binary_extension_get_block(sbin, ext);
if ( !sieve_binary_block_set_active(sbin, block, &prvblk) )
return FALSE;
offset = 0;
if ( !sieve_binary_read_unsigned(sbin, &offset, &depcount) ) {
sieve_sys_error("include: failed to read include count "
"for dependency block %d of binary %s", block, sieve_binary_path(sbin));
return FALSE;
}
/* Check include limit */
if ( depcount > EXT_INCLUDE_MAX_INCLUDES ) {
sieve_sys_error("include: binary %s includes too many scripts (%u > %u)",
sieve_binary_path(sbin), depcount, EXT_INCLUDE_MAX_INCLUDES);
return FALSE;
}
/* Read dependencies */
for ( i = 0; i < depcount; i++ ) {
unsigned int block_id;
unsigned int location;
string_t *script_name;
const char *script_dir;
struct sieve_script *script;
if (
!sieve_binary_read_unsigned(sbin, &offset, &block_id) ||
!sieve_binary_read_byte(sbin, &offset, &location) ||
!sieve_binary_read_string(sbin, &offset, &script_name) ) {
/* Binary is corrupt, recompile */
sieve_sys_error("include: failed to read included script "
"from dependency block %d of binary %s", block, sieve_binary_path(sbin));
return FALSE;
}
if ( location >= EXT_INCLUDE_LOCATION_INVALID ) {
/* Binary is corrupt, recompile */
sieve_sys_error("include: dependency block %d of binary %s "
"reports invalid script location (id %d)",
block, sieve_binary_path(sbin), location);
return FALSE;
}
/* Can we find/open the script dependency ? */
script_dir = ext_include_get_script_directory
(ext, location, str_c(script_name));
if ( script_dir == NULL ||
!(script=sieve_script_create_in_directory
(ext->svinst, script_dir, str_c(script_name), NULL, NULL)) ) {
/* No, recompile */
return FALSE;
}
(void)ext_include_binary_script_include
(binctx, script, (enum ext_include_script_location) location, block_id);
sieve_script_unref(&script);
}
if ( !ext_include_variables_load
(ext, sbin, &offset, block, &binctx->global_vars) )
return FALSE;
/* Restore previously active block */
(void)sieve_binary_block_set_active(sbin, prvblk, NULL);
return TRUE;
}
static bool ext_include_binary_up_to_date
(const struct sieve_extension *ext ATTR_UNUSED, struct sieve_binary *sbin,
void *context)
{
struct ext_include_binary_context *binctx =
(struct ext_include_binary_context *) context;
struct hash_iterate_context *hctx;
void *key, *value;
/* Check all included scripts for changes */
hctx = hash_table_iterate_init(binctx->included_scripts);
while ( hash_table_iterate(hctx, &key, &value) ) {
struct ext_include_script_info *incscript =
(struct ext_include_script_info *) value;
/* Is the binary old than this dependency? */
if ( sieve_binary_script_newer(sbin, incscript->script) ) {
/* No, recompile */
return FALSE;
}
}
hash_table_iterate_deinit(&hctx);
return TRUE;
}
static void ext_include_binary_free
(const struct sieve_extension *ext ATTR_UNUSED,
struct sieve_binary *sbin ATTR_UNUSED, void *context)
{
struct ext_include_binary_context *binctx =
(struct ext_include_binary_context *) context;
struct hash_iterate_context *hctx;
void *key, *value;
/* Release references to all included script objects */
hctx = hash_table_iterate_init(binctx->included_scripts);
while ( hash_table_iterate(hctx, &key, &value) ) {
struct ext_include_script_info *incscript =
(struct ext_include_script_info *) value;
sieve_script_unref(&incscript->script);
}
hash_table_iterate_deinit(&hctx);
hash_table_destroy(&binctx->included_scripts);
if ( binctx->global_vars != NULL )
sieve_variable_scope_unref(&binctx->global_vars);
}
/*
* Dumping the binary
*/
bool ext_include_binary_dump
(const struct sieve_extension *ext, struct sieve_dumptime_env *denv)
{
struct sieve_binary *sbin = denv->sbin;
struct ext_include_binary_context *binctx =
ext_include_binary_get_context(ext, sbin);
struct hash_iterate_context *hctx;
void *key, *value;
unsigned int prvblk = 0;
if ( !ext_include_variables_dump(denv, binctx->global_vars) )
return FALSE;
hctx = hash_table_iterate_init(binctx->included_scripts);
while ( hash_table_iterate(hctx, &key, &value) ) {
struct ext_include_script_info *incscript =
(struct ext_include_script_info *) value;
sieve_binary_dump_sectionf(denv, "Included %s script '%s' (block: %d)",
ext_include_script_location_name(incscript->location),
sieve_script_name(incscript->script), incscript->block_id);
if ( prvblk == 0 ) {
if ( !sieve_binary_block_set_active(sbin, incscript->block_id, &prvblk) )
return FALSE;
} else {
if ( !sieve_binary_block_set_active(sbin, incscript->block_id, NULL) )
return FALSE;
}
denv->cdumper = sieve_code_dumper_create(denv);
if ( denv->cdumper == NULL )
return FALSE;
sieve_code_dumper_run(denv->cdumper);
sieve_code_dumper_free(&(denv->cdumper));
}
if ( !sieve_binary_block_set_active(sbin, prvblk, NULL) )
return FALSE;
hash_table_iterate_deinit(&hctx);
return TRUE;
}
bool ext_include_code_dump
(const struct sieve_extension *ext, const struct sieve_dumptime_env *denv,
sieve_size_t *address ATTR_UNUSED)
{
struct sieve_binary *sbin = denv->sbin;
struct ext_include_binary_context *binctx =
ext_include_binary_get_context(ext, sbin);
struct ext_include_context *ectx = ext_include_get_context(ext);
sieve_ext_variables_dump_set_scope
(ectx->var_ext, denv, ext, binctx->global_vars);
return TRUE;
}
|