File: ext-include-common.h

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 (170 lines) | stat: -rw-r--r-- 4,094 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
/* Copyright (c) 2002-2013 Pigeonhole authors, see the included COPYING file
 */

#ifndef __EXT_INCLUDE_COMMON_H
#define __EXT_INCLUDE_COMMON_H

#include "lib.h"
#include "hash.h"

#include "sieve-common.h"
#include "sieve-extensions.h"

/*
 * Forward declarations
 */

struct ext_include_script_info;
struct ext_include_binary_context;

/*
 * Types
 */

enum ext_include_flags { // stored in one byte
	EXT_INCLUDE_FLAG_ONCE = 0x01,
	EXT_INCLUDE_FLAG_OPTIONAL = 0x02,
	EXT_INCLUDE_FLAG_MISSING_AT_UPLOAD = 0x04
};

enum ext_include_script_location {
	EXT_INCLUDE_LOCATION_PERSONAL,
	EXT_INCLUDE_LOCATION_GLOBAL,
	EXT_INCLUDE_LOCATION_INVALID
};

static inline const char *ext_include_script_location_name
(enum ext_include_script_location location)
{
	switch ( location ) {
	case EXT_INCLUDE_LOCATION_PERSONAL:
		return "personal";

	case EXT_INCLUDE_LOCATION_GLOBAL:
		return "global";

	default:
		break;
	}

	return "[INVALID LOCATION]";
}


/*
 * Extension
 */

extern const struct sieve_extension_def include_extension;
extern const struct sieve_binary_extension include_binary_ext;

bool ext_include_load
	(const struct sieve_extension *ext, void **context);
void ext_include_unload
	(const struct sieve_extension *ext);

/*
 * Commands
 */

extern const struct sieve_command_def cmd_include;
extern const struct sieve_command_def cmd_return;
extern const struct sieve_command_def cmd_global;

/* DEPRICATED */
extern const struct sieve_command_def cmd_import;
extern const struct sieve_command_def cmd_export;

/*
 * Operations
 */

enum ext_include_opcode {
	EXT_INCLUDE_OPERATION_INCLUDE,
	EXT_INCLUDE_OPERATION_RETURN,
	EXT_INCLUDE_OPERATION_GLOBAL
};

extern const struct sieve_operation_def include_operation;
extern const struct sieve_operation_def return_operation;
extern const struct sieve_operation_def global_operation;

/*
 * Script access
 */

const char *ext_include_get_script_location
	(const struct sieve_extension *ext,
		enum ext_include_script_location location, const char *script_name);

/*
 * Context
 */

/* Extension context */

struct ext_include_context {
	/* Extension dependencies */
	const struct sieve_extension *var_ext;

	/* Configuration */
 	char *global_dir;
	char *personal_dir;

	unsigned int max_nesting_depth;
	unsigned int max_includes;
};

static inline struct ext_include_context *ext_include_get_context
(const struct sieve_extension *ext)
{
	return (struct ext_include_context *) ext->context;
}

/* AST Context */

struct ext_include_ast_context {
  struct sieve_variable_scope *global_vars;

  ARRAY(struct sieve_script *) included_scripts;
};

struct ext_include_ast_context *ext_include_create_ast_context
	(const struct sieve_extension *this_ext, struct sieve_ast *ast,
		struct sieve_ast *parent);
struct ext_include_ast_context *ext_include_get_ast_context
	(const struct sieve_extension *this_ext, struct sieve_ast *ast);

void ext_include_ast_link_included_script
	(const struct sieve_extension *this_ext, struct sieve_ast *ast,
		struct sieve_script *script);

bool ext_include_validator_have_variables
	(const struct sieve_extension *this_ext, struct sieve_validator *valdtr);

/* Generator context */

void ext_include_register_generator_context
	(const struct sieve_extension *this_ext,
		const struct sieve_codegen_env *cgenv);

int ext_include_generate_include
	(const struct sieve_codegen_env *cgenv, struct sieve_command *cmd,
		enum ext_include_script_location location,
		enum ext_include_flags flags, struct sieve_script *script,
		const struct ext_include_script_info **included_r);

/* Interpreter context */

void ext_include_interpreter_context_init
	(const struct sieve_extension *this_ext, struct sieve_interpreter *interp);

int ext_include_execute_include
	(const struct sieve_runtime_env *renv, unsigned int block_id,
		enum ext_include_flags flags);
void ext_include_execute_return(const struct sieve_runtime_env *renv);

struct sieve_variable_storage *ext_include_interpreter_get_global_variables
	(const struct sieve_extension *this_ext, struct sieve_interpreter *interp);

#endif /* __EXT_INCLUDE_COMMON_H */