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
|
/* Copyright (c) 2002-2017 Pigeonhole authors, see the included COPYING file
*/
/* Extension fileinto
* ------------------
*
* Authors: Stephan Bosch
* Specification: RFC 5228
* Implementation: full
* Status: testing
*
*/
#include "lib.h"
#include "str-sanitize.h"
#include "unichar.h"
#include "sieve-common.h"
#include "sieve-extensions.h"
#include "sieve-binary.h"
#include "sieve-commands.h"
#include "sieve-code.h"
#include "sieve-message.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"
/*
* Forward declarations
*/
static const struct sieve_command_def fileinto_command;
const struct sieve_operation_def fileinto_operation;
const struct sieve_extension_def fileinto_extension;
/*
* Extension
*/
static bool ext_fileinto_validator_load
(const struct sieve_extension *ext, struct sieve_validator *valdtr);
const struct sieve_extension_def fileinto_extension = {
.name = "fileinto",
.validator_load = ext_fileinto_validator_load,
SIEVE_EXT_DEFINE_OPERATION(fileinto_operation)
};
static bool ext_fileinto_validator_load
(const struct sieve_extension *ext, struct sieve_validator *valdtr)
{
/* Register new command */
sieve_validator_register_command(valdtr, ext, &fileinto_command);
return TRUE;
}
/*
* Fileinto command
*
* Syntax:
* fileinto <folder: string>
*/
static bool cmd_fileinto_validate
(struct sieve_validator *valdtr, struct sieve_command *cmd);
static bool cmd_fileinto_generate
(const struct sieve_codegen_env *cgenv, struct sieve_command *ctx);
static const struct sieve_command_def fileinto_command = {
.identifier = "fileinto",
.type = SCT_COMMAND,
.positional_args = 1,
.subtests = 0,
.block_allowed = FALSE,
.block_required = FALSE,
.validate = cmd_fileinto_validate,
.generate = cmd_fileinto_generate
};
/*
* Fileinto operation
*/
static bool ext_fileinto_operation_dump
(const struct sieve_dumptime_env *denv, sieve_size_t *address);
static int ext_fileinto_operation_execute
(const struct sieve_runtime_env *renv, sieve_size_t *address);
const struct sieve_operation_def fileinto_operation = {
.mnemonic = "FILEINTO",
.ext_def = &fileinto_extension,
.dump = ext_fileinto_operation_dump,
.execute = ext_fileinto_operation_execute
};
/*
* Validation
*/
static bool cmd_fileinto_validate
(struct sieve_validator *valdtr, struct sieve_command *cmd)
{
struct sieve_ast_argument *arg = cmd->first_positional;
if ( !sieve_validate_positional_argument
(valdtr, cmd, arg, "folder", 1, SAAT_STRING) ) {
return FALSE;
}
if ( !sieve_validator_argument_activate(valdtr, cmd, arg, FALSE) )
return FALSE;
/* Check name validity when folder argument is not a variable */
if ( sieve_argument_is_string_literal(arg) ) {
const char *folder = sieve_ast_argument_strc(arg), *error;
if ( !sieve_mailbox_check_name(folder, &error) ) {
sieve_command_validate_error(valdtr, cmd,
"invalid folder name `%s' specified for fileinto command: %s",
str_sanitize(folder, 256), error);
return FALSE;
}
}
return TRUE;
}
/*
* Code generation
*/
static bool cmd_fileinto_generate
(const struct sieve_codegen_env *cgenv, struct sieve_command *cmd)
{
sieve_operation_emit(cgenv->sblock, cmd->ext, &fileinto_operation);
/* Generate arguments */
return sieve_generate_arguments(cgenv, cmd, NULL);
}
/*
* Code dump
*/
static bool ext_fileinto_operation_dump
(const struct sieve_dumptime_env *denv, sieve_size_t *address)
{
sieve_code_dumpf(denv, "FILEINTO");
sieve_code_descend(denv);
if ( sieve_action_opr_optional_dump(denv, address, NULL) != 0 )
return FALSE;
return sieve_opr_string_dump(denv, address, "folder");
}
/*
* Execution
*/
static int ext_fileinto_operation_execute
(const struct sieve_runtime_env *renv, sieve_size_t *address)
{
struct sieve_side_effects_list *slist = NULL;
string_t *folder;
bool folder_literal;
bool trace = sieve_runtime_trace_active(renv, SIEVE_TRLVL_ACTIONS);
int ret = 0;
/*
* Read operands
*/
/* Optional operands (side effects only) */
if ( sieve_action_opr_optional_read(renv, address, NULL, &ret, &slist) != 0 )
return ret;
/* Folder operand */
if ( (ret=sieve_opr_string_read_ex
(renv, address, "folder", FALSE, &folder, &folder_literal)) <= 0 )
return ret;
/*
* Perform operation
*/
if ( trace ) {
sieve_runtime_trace(renv, 0, "fileinto action");
sieve_runtime_trace_descend(renv);
}
if ( !folder_literal && !uni_utf8_str_is_valid(str_c(folder)) ) {
sieve_runtime_error(renv, NULL,
"folder name specified for fileinto command is not utf-8: %s",
str_c(folder));
return SIEVE_EXEC_FAILURE;
}
if ( trace ) {
sieve_runtime_trace(renv, 0, "store message in mailbox `%s'",
str_sanitize(str_c(folder), 80));
}
/* Add action to result */
if ( sieve_act_store_add_to_result
(renv, slist, str_c(folder)) < 0 )
return SIEVE_EXEC_FAILURE;
sieve_message_snapshot(renv->msgctx);
return SIEVE_EXEC_OK;
}
|