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 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452
|
/* Copyright (c) 2002-2013 Pigeonhole authors, see the included COPYING file
*/
#include "lib.h"
#include "array.h"
#include "buffer.h"
#include "str.h"
#include "str-sanitize.h"
#include "istream.h"
#include "ostream.h"
#include "sieve-common.h"
#include "sieve-stringlist.h"
#include "sieve-binary.h"
#include "sieve-code.h"
#include "sieve-message.h"
#include "sieve-extensions.h"
#include "sieve-commands.h"
#include "sieve-actions.h"
#include "sieve-validator.h"
#include "sieve-generator.h"
#include "sieve-interpreter.h"
#include "sieve-dump.h"
#include "sieve-result.h"
#include "sieve-ext-variables.h"
#include "sieve-extprograms-common.h"
/* Execute command
*
* Syntax:
* "execute" [":input" <input-data: string> / ":pipe"]
* [":output" <varname: string>]
* <program-name: string> [<arguments: string-list>]
*
*/
static bool cmd_execute_registered
(struct sieve_validator *valdtr, const struct sieve_extension *ext,
struct sieve_command_registration *cmd_reg);
static bool cmd_execute_generate
(const struct sieve_codegen_env *cgenv,
struct sieve_command *ctx);
const struct sieve_command_def cmd_execute = {
"execute",
SCT_HYBRID,
-1, /* We check positional arguments ourselves */
0, FALSE, FALSE,
cmd_execute_registered,
NULL,
sieve_extprogram_command_validate,
NULL,
cmd_execute_generate,
NULL,
};
/*
* Tagged arguments
*/
static bool cmd_execute_validate_input_tag
(struct sieve_validator *valdtr, struct sieve_ast_argument **arg,
struct sieve_command *cmd);
static bool cmd_execute_generate_input_tag
(const struct sieve_codegen_env *cgenv, struct sieve_ast_argument *arg,
struct sieve_command *cmd);
static bool cmd_execute_validate_output_tag
(struct sieve_validator *valdtr, struct sieve_ast_argument **arg,
struct sieve_command *cmd);
static const struct sieve_argument_def execute_input_tag = {
"input",
NULL,
cmd_execute_validate_input_tag,
NULL, NULL,
cmd_execute_generate_input_tag
};
static const struct sieve_argument_def execute_pipe_tag = {
"pipe",
NULL,
cmd_execute_validate_input_tag,
NULL, NULL,
cmd_execute_generate_input_tag
};
static const struct sieve_argument_def execute_output_tag = {
"output",
NULL,
cmd_execute_validate_output_tag,
NULL, NULL, NULL
};
/*
* Execute operation
*/
static bool cmd_execute_operation_dump
(const struct sieve_dumptime_env *denv, sieve_size_t *address);
static int cmd_execute_operation_execute
(const struct sieve_runtime_env *renv, sieve_size_t *address);
const struct sieve_operation_def cmd_execute_operation = {
"EXECUTE", &execute_extension,
0,
cmd_execute_operation_dump,
cmd_execute_operation_execute
};
/* Codes for optional operands */
enum cmd_execute_optional {
OPT_END,
OPT_INPUT,
OPT_OUTPUT
};
/*
* Tag validation
*/
static bool cmd_execute_validate_input_tag
(struct sieve_validator *valdtr, struct sieve_ast_argument **arg,
struct sieve_command *cmd)
{
struct sieve_ast_argument *tag = *arg;
if ( (bool) cmd->data ) {
sieve_argument_validate_error(valdtr, *arg,
"multiple :input or :pipe arguments specified for the %s %s",
sieve_command_identifier(cmd), sieve_command_type_name(cmd));
return FALSE;
}
cmd->data = (void *) TRUE;
/* Skip tag */
*arg = sieve_ast_argument_next(*arg);
if ( sieve_argument_is(tag, execute_input_tag) ) {
/* Check syntax:
* :input <input-data: string>
*/
if ( !sieve_validate_tag_parameter
(valdtr, cmd, tag, *arg, NULL, 0, SAAT_STRING, FALSE) ) {
return FALSE;
}
/* Assign tag parameters */
tag->parameters = *arg;
*arg = sieve_ast_arguments_detach(*arg,1);
}
return TRUE;
}
static bool cmd_execute_validate_output_tag
(struct sieve_validator *valdtr, struct sieve_ast_argument **arg,
struct sieve_command *cmd)
{
struct sieve_ast_argument *tag = *arg;
struct sieve_extprograms_config *ext_config =
(struct sieve_extprograms_config *) cmd->ext->context;
if ( ext_config == NULL || ext_config->var_ext == NULL ||
!sieve_ext_variables_is_active(ext_config->var_ext, valdtr) ) {
sieve_argument_validate_error(valdtr,*arg,
"the %s %s only allows for the specification of an "
":output argument when the variables extension is active",
sieve_command_identifier(cmd), sieve_command_type_name(cmd));
return FALSE;
}
/* Detach the tag itself */
*arg = sieve_ast_arguments_detach(*arg, 1);
if ( !sieve_variable_argument_activate
(ext_config->var_ext, valdtr, cmd, *arg, TRUE) )
return FALSE;
(*arg)->argument->id_code = tag->argument->id_code;
/* Skip parameter */
*arg = sieve_ast_argument_next(*arg);
return TRUE;
}
/*
* Command registration
*/
static bool cmd_execute_registered
(struct sieve_validator *valdtr, const struct sieve_extension *ext,
struct sieve_command_registration *cmd_reg)
{
sieve_validator_register_tag
(valdtr, cmd_reg, ext, &execute_input_tag, OPT_INPUT);
sieve_validator_register_tag
(valdtr, cmd_reg, ext, &execute_pipe_tag, OPT_INPUT);
sieve_validator_register_tag
(valdtr, cmd_reg, ext, &execute_output_tag, OPT_OUTPUT);
return TRUE;
}
/*
* Code generation
*/
static bool cmd_execute_generate_input_tag
(const struct sieve_codegen_env *cgenv, struct sieve_ast_argument *arg,
struct sieve_command *cmd)
{
if ( arg->parameters == NULL ) {
sieve_opr_omitted_emit(cgenv->sblock);
return TRUE;
}
return sieve_generate_argument_parameters(cgenv, cmd, arg);
}
static bool cmd_execute_generate
(const struct sieve_codegen_env *cgenv, struct sieve_command *cmd)
{
sieve_operation_emit(cgenv->sblock, cmd->ext, &cmd_execute_operation);
/* Emit is_test flag */
sieve_binary_emit_byte(cgenv->sblock, ( cmd->ast_node->type == SAT_TEST ));
/* Generate arguments */
if ( !sieve_generate_arguments(cgenv, cmd, NULL) )
return FALSE;
/* Emit a placeholder when the <arguments> argument is missing */
if ( sieve_ast_argument_next(cmd->first_positional) == NULL )
sieve_opr_omitted_emit(cgenv->sblock);
return TRUE;
}
/*
* Code dump
*/
static bool cmd_execute_operation_dump
(const struct sieve_dumptime_env *denv, sieve_size_t *address)
{
int opt_code = 0;
unsigned int is_test = 0;
/* Read is_test flag */
if ( !sieve_binary_read_byte(denv->sblock, address, &is_test) )
return FALSE;
sieve_code_dumpf(denv, "EXECUTE (%s)", (is_test ? "test" : "command"));
sieve_code_descend(denv);
/* Dump optional operands */
for (;;) {
int opt;
bool opok = TRUE;
if ( (opt=sieve_action_opr_optional_dump(denv, address, &opt_code)) < 0 )
return FALSE;
if ( opt == 0 ) break;
switch ( opt_code ) {
case OPT_INPUT:
opok = sieve_opr_string_dump_ex(denv, address, "input", "PIPE");
break;
case OPT_OUTPUT:
opok = sieve_opr_string_dump(denv, address, "output");
break;
default:
return FALSE;
}
if ( !opok ) return FALSE;
}
if ( !sieve_opr_string_dump(denv, address, "program-name") )
return FALSE;
return sieve_opr_stringlist_dump_ex(denv, address, "arguments", "");
}
/*
* Code execution
*/
static int cmd_execute_operation_execute
(const struct sieve_runtime_env *renv, sieve_size_t *address)
{
const struct sieve_extension *this_ext = renv->oprtn->ext;
struct sieve_side_effects_list *slist = NULL;
int opt_code = 0;
unsigned int is_test = 0;
struct sieve_stringlist *args_list = NULL;
string_t *pname = NULL, *input = NULL;
struct sieve_variable_storage *var_storage = NULL;
unsigned int var_index;
bool have_input = FALSE;
const char *program_name = NULL;
const char *const *args = NULL;
enum sieve_error error = SIEVE_ERROR_NONE;
buffer_t *outbuf = NULL;
struct sieve_extprogram *sprog = NULL;
int ret;
/*
* Read operands
*/
/* The is_test flag */
if ( !sieve_binary_read_byte(renv->sblock, address, &is_test) ) {
sieve_runtime_trace_error(renv, "invalid is_test flag");
return SIEVE_EXEC_BIN_CORRUPT;
}
/* Optional operands */
for (;;) {
int opt;
if ( (opt=sieve_action_opr_optional_read
(renv, address, &opt_code, &ret, &slist)) < 0 )
return ret;
if ( opt == 0 ) break;
switch ( opt_code ) {
case OPT_INPUT:
if ( (ret=sieve_opr_string_read_ex
(renv, address, "input", TRUE, &input, NULL)) <= 0 )
return ret;
have_input = TRUE;
break;
case OPT_OUTPUT:
if ( (ret=sieve_variable_operand_read
(renv, address, "output", &var_storage, &var_index)) <= 0 )
return ret;
break;
default:
sieve_runtime_trace_error(renv, "unknown optional operand");
return SIEVE_EXEC_BIN_CORRUPT;
}
if ( ret <= 0 ) return ret;
}
/* Fixed operands */
if ( (ret=sieve_extprogram_command_read_operands
(renv, address, &pname, &args_list)) <= 0 )
return ret;
program_name = str_c(pname);
if ( args_list != NULL &&
sieve_stringlist_read_all(args_list, pool_datastack_create(), &args) < 0 ) {
sieve_runtime_trace_error(renv, "failed to read args operand");
return args_list->exec_status;
}
/*
* Perform operation
*/
/* Trace */
sieve_runtime_trace(renv, SIEVE_TRLVL_ACTIONS, "execute action");
sieve_runtime_trace_descend(renv);
sieve_runtime_trace(renv, SIEVE_TRLVL_ACTIONS,
"execute program `%s'", str_sanitize(program_name, 128));
sprog = sieve_extprogram_create
(this_ext, renv->scriptenv, renv->msgdata, "execute", program_name, args,
&error);
if ( sprog != NULL ) {
if ( var_storage != NULL ) {
// FIXME: limit output size
struct ostream *outdata;
outbuf = buffer_create_dynamic(pool_datastack_create(), 1024);
outdata = o_stream_create_buffer(outbuf);
sieve_extprogram_set_output(sprog, outdata);
o_stream_unref(&outdata);
}
if ( input == NULL && have_input ) {
ret = sieve_extprogram_set_input_mail
(sprog, sieve_message_get_mail(renv->msgctx));
} else if ( input != NULL ) {
struct istream *indata =
i_stream_create_from_data(str_data(input), str_len(input));
sieve_extprogram_set_input(sprog, indata);
i_stream_unref(&indata);
ret = 1;
}
if ( ret >= 0 )
ret = sieve_extprogram_run(sprog);
sieve_extprogram_destroy(&sprog);
} else {
ret = -1;
}
if ( ret > 0 ) {
sieve_runtime_trace(renv, SIEVE_TRLVL_ACTIONS,
"executed program successfully");
if ( var_storage != NULL ) {
string_t *var;
if ( sieve_variable_get_modifiable(var_storage, var_index, &var) ) {
str_truncate(var, 0);
str_append_str(var, outbuf);
sieve_runtime_trace(renv, SIEVE_TRLVL_ACTIONS,
"assigned output variable");
} // FIXME: handle failure
}
} else if ( ret < 0 ) {
if ( error == SIEVE_ERROR_NOT_FOUND ) {
sieve_runtime_error(renv, NULL,
"execute action: program `%s' not found",
str_sanitize(program_name, 80));
} else {
sieve_extprogram_exec_error(renv->ehandler,
sieve_runtime_get_full_command_location(renv),
"execute action: failed to execute to program `%s'",
str_sanitize(program_name, 80));
}
} else {
sieve_runtime_trace(renv, SIEVE_TRLVL_ACTIONS,
"execute action: program indicated false result");
}
if ( outbuf != NULL )
buffer_free(&outbuf);
if ( is_test )
sieve_interpreter_set_test_result(renv->interp, ( ret > 0 ));
return SIEVE_EXEC_OK;
}
|