Local_scan: more guards in included files
[exim.git] / src / src / local_scan.h
CommitLineData
059ec3d9
PH
1/*************************************************
2* Exim - an Internet mail transport agent *
3*************************************************/
4
13a4b4c1 5/* Copyright (c) University of Cambridge 1995 - 2020 */
059ec3d9
PH
6/* See the file NOTICE for conditions of use and distribution. */
7
8/* This file is the header that is the only Exim header to be included in the
9source for the local_scan.c() function. It contains definitions that are made
9b230009
JH
10available for use in that function, and which are documented. That source
11should first #define LOCAL_SCAN
1a46a8c5 12
df92b047
JH
13Not every definition that becomes available to the compiler by the inclusion
14of this file is part of the local_scan API. The "Adding a local scan function
15to Exim" chapter in the documentation is definitive.
16
f0ed88da 17This API is also used for functions called by the ${dlfunc expansion item.
9b230009 18Source for those should first #define DLFUNC_IMPL and then include this file.
f0ed88da
JH
19Coders of dlfunc routines should read the notes on tainting at the start of
20store.c
21*/
059ec3d9
PH
22
23
750af86e
PH
24/* Some basic types that make some things easier, the Exim configuration
25settings, and the store functions. */
059ec3d9 26
ce552449 27#include <stdarg.h>
059ec3d9 28#include <sys/types.h>
750af86e 29#include "config.h"
059ec3d9
PH
30#include "mytypes.h"
31#include "store.h"
32
33
34/* The function and its return codes. */
35
36extern int local_scan(int, uschar **);
37
38enum {
39 LOCAL_SCAN_ACCEPT, /* Accept */
40 LOCAL_SCAN_ACCEPT_FREEZE, /* Accept, but freeze */
41 LOCAL_SCAN_ACCEPT_QUEUE, /* Accept, but no immediate delivery */
42 LOCAL_SCAN_REJECT, /* Permanent rejection */
43 LOCAL_SCAN_REJECT_NOLOGHDR, /* Permanent rejection, no log header */
44 LOCAL_SCAN_TEMPREJECT, /* Temporary rejection */
45 LOCAL_SCAN_TEMPREJECT_NOLOGHDR /* Temporary rejection, no log header */
46};
47
48
1a46a8c5
PH
49/* Functions called by ${dlfunc{file}{func}{arg}...} return one of the five
50status codes defined immediately below. The function's first argument is either
51the result of expansion, or the error message in case of failure. The second
52and third arguments are standard argument count and vector, comprising the
53{arg} values specified in the expansion item. */
54
55typedef int exim_dlfunc_t(uschar **yield, int argc, uschar *argv[]);
56
57
58/* Return codes from the support functions lss_match_xxx(). These are also the
59codes that dynamically-loaded ${dlfunc functions must return. */
059ec3d9
PH
60
61#define OK 0 /* Successful match */
62#define DEFER 1 /* Defer - some problem */
63#define FAIL 2 /* Matching failed */
64#define ERROR 3 /* Internal or config error */
65
1a46a8c5
PH
66/* Extra return code for ${dlfunc functions */
67
68#define FAIL_FORCED 4 /* "Forced" failure */
69
059ec3d9
PH
70
71/* Available logging destinations */
72
73#define LOG_MAIN 1 /* Write to the main log */
74#define LOG_PANIC 2 /* Write to the panic log */
75#define LOG_REJECT 16 /* Write to the reject log, with headers */
76
77
78/* Accessible debugging bits */
79
80#define D_v 0x00000001
81#define D_local_scan 0x00000002
82
83
84/* Option types that can be used for local_scan_options. The boolean ones
85MUST be last so that they are contiguous with the internal boolean specials. */
86
87enum { opt_stringptr, opt_int, opt_octint, opt_mkint, opt_Kint, opt_fixed,
88 opt_time, opt_bool };
89
90
91/* The length of message identification strings. This is the id used internally
92by exim. The external version for use in Received: strings has a leading 'E'
93added to ensure it starts with a letter. */
94
95#define MESSAGE_ID_LENGTH 16
96
97/* The offset to the start of the data in the data file - this allows for
98the name of the data file to be present in the first line. */
99
100#define SPOOL_DATA_START_OFFSET (MESSAGE_ID_LENGTH+3)
101
102/* Some people (Marc Merlin et al) are maintaining a patch that allows for
103dynamic local_scan() libraries. This code is not yet in Exim proper, but it
104helps the maintainers if we keep their ABI version numbers here. This may
105mutate into more general support later. The major number is increased when the
106ABI is changed in a non backward compatible way. The minor number is increased
107each time a new feature is added (in a way that doesn't break backward
108compatibility). */
109
13a4b4c1
JH
110#define LOCAL_SCAN_ABI_VERSION_MAJOR 4
111#define LOCAL_SCAN_ABI_VERSION_MINOR 0
e57faad2
MH
112#define LOCAL_SCAN_ABI_VERSION \
113 LOCAL_SCAN_ABI_VERSION_MAJOR.LOCAL_SCAN_ABI_VERSION_MINOR
059ec3d9
PH
114
115/* Structure definitions that are documented as visible in the function. */
116
117typedef struct header_line {
118 struct header_line *next;
119 int type;
120 int slen;
121 uschar *text;
122} header_line;
123
124/* Entries in lists options are in this form. */
125
126typedef struct {
a73f0547
JH
127 const char * name; /* should have been uschar but too late now */
128 int type;
129 union {
130 void * value;
13a4b4c1 131 long offset;
a73f0547
JH
132 void (* fn)();
133 } v;
059ec3d9 134} optionlist;
13a4b4c1 135#define OPT_OFF(s, field) {.offset = offsetof(s, field)}
059ec3d9 136
d81d33cf 137/* Structure for holding information about an envelope address. The errors_to
059ec3d9
PH
138field is always NULL except for one_time aliases that had errors_to on the
139routers that generated them. */
140
141typedef struct recipient_item {
142 uschar *address; /* the recipient address */
143 int pno; /* parent number for "one_time" alias, or -1 */
144 uschar *errors_to; /* the errors_to address or NULL */
6c1c3d1d
WB
145 uschar *orcpt; /* DSN orcpt */
146 int dsn_flags; /* DSN flags */
8523533c
TK
147#ifdef EXPERIMENTAL_BRIGHTMAIL
148 uschar *bmi_optin;
149#endif
059ec3d9
PH
150} recipient_item;
151
152
153/* Global variables that are documented as visible in the function. */
154
155extern unsigned int debug_selector; /* Debugging bits */
156
2b85bce7
PH
157extern int body_linecount; /* Line count in body */
158extern int body_zerocount; /* Binary zero count in body */
059ec3d9
PH
159extern uschar *expand_string_message; /* Error info for failing expansion */
160extern uschar *headers_charset; /* Charset for RFC 2047 decoding */
161extern header_line *header_last; /* Final header */
162extern header_line *header_list; /* First header */
163extern BOOL host_checking; /* Set when checking a host */
164extern uschar *interface_address; /* Interface for incoming call */
165extern int interface_port; /* Port number for incoming call */
166extern uschar *message_id; /* Internal id of message being handled */
167extern uschar *received_protocol; /* Name of incoming protocol */
168extern int recipients_count; /* Number of recipients */
169extern recipient_item *recipients_list;/* List of recipient addresses */
170extern unsigned char *sender_address; /* Sender address */
171extern uschar *sender_host_address; /* IP address of sender, as chars */
172extern uschar *sender_host_authenticated; /* Name of authentication mechanism */
173extern uschar *sender_host_name; /* Host name from lookup */
174extern int sender_host_port; /* Port number of sender */
175extern BOOL smtp_batched_input; /* TRUE if SMTP batch (no interaction) */
176extern BOOL smtp_input; /* TRUE if input is via SMTP */
177
178
179/* Functions that are documented as visible in local_scan(). */
180
181extern int child_close(pid_t, int);
182extern pid_t child_open(uschar **, uschar **, int, int *, int *, BOOL);
183extern pid_t child_open_exim(int *);
5977a0b3 184extern pid_t child_open_exim2(int *, uschar *, uschar *);
1ba28e2b 185extern void debug_printf(const char *, ...) PRINTF_FUNCTION(1,2);
059ec3d9 186extern uschar *expand_string(uschar *);
1ba28e2b
PP
187extern void header_add(int, const char *, ...);
188extern void header_add_at_position(BOOL, uschar *, BOOL, int, const char *, ...);
189extern void header_remove(int, const uschar *);
190extern BOOL header_testname(header_line *, const uschar *, int, BOOL);
191extern BOOL header_testname_incomplete(header_line *, const uschar *, int, BOOL);
e0df1c83 192extern void log_write(unsigned int, int, const char *format, ...) PRINTF_FUNCTION(3,4);
059ec3d9
PH
193extern int lss_b64decode(uschar *, uschar **);
194extern uschar *lss_b64encode(uschar *, int);
195extern int lss_match_domain(uschar *, uschar *);
196extern int lss_match_local_part(uschar *, uschar *, BOOL);
197extern int lss_match_address(uschar *, uschar *, BOOL);
198extern int lss_match_host(uschar *, uschar *, uschar *);
199extern void receive_add_recipient(uschar *, int);
200extern BOOL receive_remove_recipient(uschar *);
201extern uschar *rfc2047_decode(uschar *, BOOL, uschar *, int, int *, uschar **);
202extern int smtp_fflush(void);
925ac8e4
JH
203extern void smtp_printf(const char *, BOOL, ...) PRINTF_FUNCTION(1,3);
204extern void smtp_vprintf(const char *, BOOL, va_list);
f3ebb786
JH
205
206#define string_sprintf(fmt, ...) \
c4efe382 207 string_sprintf_trc(fmt, US __FUNCTION__, __LINE__, __VA_ARGS__)
f3ebb786 208extern uschar *string_sprintf_trc(const char *, const uschar *, unsigned, ...) ALMOST_PRINTF(1,4);
059ec3d9 209
4ec0fcb6
JH
210#define store_get(size, tainted) \
211 store_get_3(size, tainted, __FUNCTION__, __LINE__)
212extern void *store_get_3(int, BOOL, const char *, int) ALLOC ALLOC_SIZE(1) WARN_UNUSED_RESULT;
213#define store_get_perm(size, tainted) \
214 store_get_perm_3(size, tainted, __FUNCTION__, __LINE__)
215extern void *store_get_perm_3(int, BOOL, const char *, int) ALLOC ALLOC_SIZE(1) WARN_UNUSED_RESULT;
216
217
8b5d88d2 218#if defined(LOCAL_SCAN) || defined(DLFUNC_IMPL)
e59797e3
JH
219/* When compiling a local_scan() file we want to rename a published API, so that
220we can use an inlined implementation in the compiles of the main Exim files,
221with the original name. */
222
223# define string_copy(s) string_copy_function(s)
d48326c0
JH
224# define string_copyn(s, n) string_copyn_function((s), (n))
225# define string_copy_taint(s, t) string_copy_taint_function((s), (t))
e59797e3
JH
226
227extern uschar * string_copy_function(const uschar *);
b4a15239
JH
228extern uschar * string_copyn_function(const uschar *, int n);
229extern uschar * string_copy_taint_function(const uschar *, BOOL tainted);
e59797e3
JH
230#endif
231
059ec3d9 232/* End of local_scan.h */