File: tst-size.c

package info (click to toggle)
dovecot 1:2.2.13-12~deb8u4
  • links: PTS, VCS
  • area: main
  • in suites: jessie
  • size: 38,792 kB
  • sloc: ansic: 341,472; sh: 16,920; makefile: 5,393; cpp: 1,474; perl: 265; xml: 44; python: 34; pascal: 27
file content (304 lines) | stat: -rw-r--r-- 7,038 bytes parent folder | download | duplicates (3)
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
/* Copyright (c) 2002-2013 Pigeonhole authors, see the included COPYING file
 */

#include "lib.h"

#include "sieve-common.h"
#include "sieve-code.h"
#include "sieve-message.h"
#include "sieve-commands.h"
#include "sieve-validator.h"
#include "sieve-generator.h"
#include "sieve-interpreter.h"
#include "sieve-dump.h"

/*
 * Size test
 *
 * Syntax:
 *    size <":over" / ":under"> <limit: number>
 */

static bool tst_size_registered
	(struct sieve_validator *valdtr, const struct sieve_extension *ext,
		struct sieve_command_registration *cmd_reg);
static bool tst_size_pre_validate
	(struct sieve_validator *valdtr, struct sieve_command *tst);
static bool tst_size_validate
	(struct sieve_validator *valdtr, struct sieve_command *tst);
static bool tst_size_generate
	(const struct sieve_codegen_env *cgenv, struct sieve_command *ctx);

const struct sieve_command_def tst_size = {
	"size",
	SCT_TEST,
	1, 0, FALSE, FALSE,
	tst_size_registered,
	tst_size_pre_validate,
	tst_size_validate,
	NULL,
	tst_size_generate,
	NULL
};

/*
 * Size operations
 */

static bool tst_size_operation_dump
	(const struct sieve_dumptime_env *denv, sieve_size_t *address);
static int tst_size_operation_execute
	(const struct sieve_runtime_env *renv, sieve_size_t *address);

const struct sieve_operation_def tst_size_over_operation = {
	"SIZE-OVER",
	NULL,
	SIEVE_OPERATION_SIZE_OVER,
	tst_size_operation_dump,
	tst_size_operation_execute
};

const struct sieve_operation_def tst_size_under_operation = {
	"SIZE-UNDER",
	NULL,
	SIEVE_OPERATION_SIZE_UNDER,
	tst_size_operation_dump,
	tst_size_operation_execute
};

/*
 * Context data
 */

struct tst_size_context_data {
	enum { SIZE_UNASSIGNED, SIZE_UNDER, SIZE_OVER } type;
};

#define TST_SIZE_ERROR_DUP_TAG \
	"exactly one of the ':under' or ':over' tags must be specified " \
	"for the size test, but more were found"

/*
 * Tag validation
 */

static bool tst_size_validate_over_tag
(struct sieve_validator *valdtr, struct sieve_ast_argument **arg,
	struct sieve_command *tst)
{
	struct tst_size_context_data *ctx_data =
		(struct tst_size_context_data *) tst->data;

	if ( ctx_data->type != SIZE_UNASSIGNED ) {
		sieve_argument_validate_error(valdtr, *arg, TST_SIZE_ERROR_DUP_TAG);
		return FALSE;
	}

	ctx_data->type = SIZE_OVER;

	/* Delete this tag */
	*arg = sieve_ast_arguments_detach(*arg, 1);

	return TRUE;
}

static bool tst_size_validate_under_tag
(struct sieve_validator *valdtr, struct sieve_ast_argument **arg ATTR_UNUSED,
	struct sieve_command *tst)
{
	struct tst_size_context_data *ctx_data =
		(struct tst_size_context_data *) tst->data;

	if ( ctx_data->type != SIZE_UNASSIGNED ) {
		sieve_argument_validate_error(valdtr, *arg, TST_SIZE_ERROR_DUP_TAG);
		return FALSE;
	}

	ctx_data->type = SIZE_UNDER;

	/* Delete this tag */
	*arg = sieve_ast_arguments_detach(*arg, 1);

	return TRUE;
}

/*
 * Test registration
 */

static const struct sieve_argument_def size_over_tag = {
	"over",
	NULL,
	tst_size_validate_over_tag,
	NULL, NULL, NULL
};

static const struct sieve_argument_def size_under_tag = {
	"under",
	NULL,
	tst_size_validate_under_tag,
	NULL, NULL,  NULL
};

static bool tst_size_registered
(struct sieve_validator *valdtr, const struct sieve_extension *ext ATTR_UNUSED,
	struct sieve_command_registration *cmd_reg)
{
	/* Register our tags */
	sieve_validator_register_tag(valdtr, cmd_reg, NULL, &size_over_tag, 0);
	sieve_validator_register_tag(valdtr, cmd_reg, NULL, &size_under_tag, 0);

	return TRUE;
}

/*
 * Test validation
 */

static bool tst_size_pre_validate
(struct sieve_validator *valdtr ATTR_UNUSED,
	struct sieve_command *tst)
{
	struct tst_size_context_data *ctx_data;

	/* Assign context */
	ctx_data = p_new(sieve_command_pool(tst), struct tst_size_context_data, 1);
	ctx_data->type = SIZE_UNASSIGNED;
	tst->data = ctx_data;

	return TRUE;
}

static bool tst_size_validate
	(struct sieve_validator *valdtr, struct sieve_command *tst)
{
	struct tst_size_context_data *ctx_data =
		(struct tst_size_context_data *) tst->data;
	struct sieve_ast_argument *arg = tst->first_positional;

	if ( ctx_data->type == SIZE_UNASSIGNED ) {
		sieve_command_validate_error(valdtr, tst,
			"the size test requires either the :under or the :over tag "
			"to be specified");
		return FALSE;
	}

	if ( !sieve_validate_positional_argument
		(valdtr, tst, arg, "limit", 1, SAAT_NUMBER) ) {
		return FALSE;
	}

	return sieve_validator_argument_activate(valdtr, tst, arg, FALSE);
}

/*
 * Code generation
 */

bool tst_size_generate
(const struct sieve_codegen_env *cgenv, struct sieve_command *tst)
{
	struct tst_size_context_data *ctx_data =
		(struct tst_size_context_data *) tst->data;

	if ( ctx_data->type == SIZE_OVER )
		sieve_operation_emit(cgenv->sblock, NULL, &tst_size_over_operation);
	else
		sieve_operation_emit(cgenv->sblock, NULL, &tst_size_under_operation);

 	/* Generate arguments */
	if ( !sieve_generate_arguments(cgenv, tst, NULL) )
		return FALSE;

	return TRUE;
}

/*
 * Code dump
 */

static bool tst_size_operation_dump
(const struct sieve_dumptime_env *denv, sieve_size_t *address)
{
	sieve_code_dumpf(denv, "%s", sieve_operation_mnemonic(denv->oprtn));
	sieve_code_descend(denv);

	return
		sieve_opr_number_dump(denv, address, "limit");
}

/*
 * Code execution
 */

static inline bool tst_size_get
(const struct sieve_runtime_env *renv, sieve_number_t *size)
{
	struct mail *mail = sieve_message_get_mail(renv->msgctx);
	uoff_t psize;

	if ( mail_get_physical_size(mail, &psize) < 0 )
		return FALSE;

	*size = psize;

	return TRUE;
}

static int tst_size_operation_execute
(const struct sieve_runtime_env *renv, sieve_size_t *address)
{
	sieve_number_t mail_size, limit;
	int ret;

	/*
	 * Read operands
	 */

	/* Read size limit */
	if ( (ret=sieve_opr_number_read(renv, address, "limit", &limit)) <= 0 )
		return ret;

	/*
	 * Perform test
	 */

	/* Get the size of the message */
	if ( !tst_size_get(renv, &mail_size) ) {
		/* FIXME: improve this error */
		sieve_sys_error(renv->svinst, "failed to assess message size");
		return SIEVE_EXEC_FAILURE;
	}

	/* Perform the test */
	if ( sieve_operation_is(renv->oprtn, tst_size_over_operation) ) {
		sieve_runtime_trace(renv, SIEVE_TRLVL_TESTS, "size :over test");

		if ( sieve_runtime_trace_active(renv, SIEVE_TRLVL_MATCHING) ) {
			sieve_runtime_trace_descend(renv);

			sieve_runtime_trace(renv, 0,
				"comparing message size %lu", (unsigned long) mail_size);
			sieve_runtime_trace(renv, 0,
				"with upper limit %lu", (unsigned long) limit);
		}

		sieve_interpreter_set_test_result(renv->interp, (mail_size > limit));
	} else {
		sieve_runtime_trace(renv, SIEVE_TRLVL_TESTS, "size :under test");

		if ( sieve_runtime_trace_active(renv, SIEVE_TRLVL_MATCHING) ) {
			sieve_runtime_trace_descend(renv);

			sieve_runtime_trace(renv, 0,
				"comparing message size %lu", (unsigned long) mail_size);
			sieve_runtime_trace(renv, 0,
				"with lower limit %lu", (unsigned long) limit);
		}

		sieve_interpreter_set_test_result(renv->interp, (mail_size < limit));
	}

	return SIEVE_EXEC_OK;
}