f73ce63ac8753eca9343251f185499dee8e68eb7
[exim.git] / src / src / macros.h
1 /* $Cambridge: exim/src/src/macros.h,v 1.31 2007/01/31 16:52:12 ph10 Exp $ */
2
3 /*************************************************
4 *     Exim - an Internet mail transport agent    *
5 *************************************************/
6
7 /* Copyright (c) University of Cambridge 1995 - 2007 */
8 /* See the file NOTICE for conditions of use and distribution. */
9
10
11 /* These two macros make it possible to obtain the result of macro-expanding
12 a string as a text string. This is sometimes useful for debugging output. */
13
14 #define mac_string(s) # s
15 #define mac_expanded_string(s) mac_string(s)
16
17
18 /* The address_item structure has a word full of 1-bit flags. These macros
19 manipulate them. */
20
21 #define setflag(addr,flag)    addr->flags |= (flag)
22 #define clearflag(addr,flag)  addr->flags &= ~(flag)
23
24 #define testflag(addr,flag)       ((addr->flags & (flag)) != 0)
25 #define testflagsall(addr,flag)   ((addr->flags & (flag)) == (flag))
26
27 #define copyflag(addrnew,addrold,flag) \
28   addrnew->flags = (addrnew->flags & ~(flag)) | (addrold->flags & (flag))
29
30 #define orflag(addrnew,addrold,flag) \
31   addrnew->flags |= addrold->flags & (flag)
32
33
34 /* For almost all calls to convert things to printing characters, we want to
35 allow tabs. A macro just makes life a bit easier. */
36
37 #define string_printing(s) string_printing2((s), TRUE)
38
39
40 /* We need a special return code for "no recipients and failed to send an error
41 message". ANSI C defines only EXIT_FAILURE and EXIT_SUCCESS. On the assumption
42 that these are always 1 and 0 on Unix systems ... */
43
44 #define EXIT_NORECIPIENTS 2
45
46
47 /* Character-handling macros. It seems that the set of standard functions in
48 ctype.h aren't actually all that useful. One reason for this is that email is
49 international, so the concept of using a locale to vary what they do is not
50 helpful. Another problem is that in different operating systems, the libraries
51 yield different results, even in the default locale. For example, Linux yields
52 TRUE for iscntrl() for all characters > 127, whereas many other systems yield
53 FALSE. For these reasons we define our own set of macros for a number of
54 character testing functions. Ensure that all these tests treat their arguments
55 as unsigned. */
56
57 #define mac_iscntrl(c) \
58   ((uschar)(c) < 32 || (uschar)(c) == 127)
59
60 #define mac_iscntrl_or_special(c) \
61   ((uschar)(c) < 32 || strchr(" ()<>@,;:\\\".[]\177", (uschar)(c)) != NULL)
62
63 #define mac_isgraph(c) \
64   ((uschar)(c) > 32 && (uschar)(c) != 127)
65
66 #define mac_isprint(c) \
67   (((uschar)(c) >= 32 && (uschar)(c) <= 126) || c == '\t' || \
68   ((uschar)(c) > 127 && print_topbitchars))
69
70
71 /* When built with TLS support, the act of flushing SMTP output becomes
72 a no-op once an SSL session is in progress. */
73
74 #ifdef SUPPORT_TLS
75 #define mac_smtp_fflush() if (tls_active < 0) fflush(smtp_out);
76 #else
77 #define mac_smtp_fflush() fflush(smtp_out);
78 #endif
79
80
81 /* Define which ends of pipes are for reading and writing, as some systems
82 don't make the file descriptors two-way. */
83
84 #define pipe_read  0
85 #define pipe_write 1
86
87 /* The RFC 1413 ident port */
88
89 #define IDENT_PORT 113
90
91 /* A macro to simplify testing bits in lookup types */
92
93 #define mac_islookup(a,b) ((lookup_list[a].type & (b)) != 0)
94
95 /* Debugging control */
96
97 #define DEBUG(x)      if ((debug_selector & (x)) != 0)
98 #define HDEBUG(x)     if (host_checking || (debug_selector & (x)) != 0)
99
100 /* The size of the vector for saving/restoring address expansion pointers while
101 verifying. This has to be explicit because it is referenced in more than one
102 source module. */
103
104 #define ADDRESS_EXPANSIONS_COUNT 18
105
106 /* The maximum permitted number of command-line (-D) macro definitions. We
107 need a limit only to make it easier to generate argument vectors for re-exec
108 of Exim. */
109
110 #define MAX_CLMACROS 10
111
112 /* The number of integer variables available in filter files. If this is
113 changed, then the tables in expand.c for accessing them must be changed too. */
114
115 #define FILTER_VARIABLE_COUNT 10
116
117 /* The size of the vector holding delay warning times */
118
119 #define DELAY_WARNING_SIZE 12
120
121 /* The size of the buffer holding the processing information string. */
122
123 #define PROCESS_INFO_SIZE 256
124
125 /* The size of buffer to get for constructing log entries. Make it big
126 enough to hold all the headers from a normal kind of message. */
127
128 #define LOG_BUFFER_SIZE 8192
129
130 /* The size of the circular buffer that remembers recent SMTP commands */
131
132 #define SMTP_HBUFF_SIZE 20
133
134 /* The initial size of a big buffer for use in various places. It gets put
135 into big_buffer_size and in some circumstances increased. It should be at least
136 as long as the maximum path length. */
137
138 #if defined PATH_MAX && PATH_MAX > 16384
139 #define BIG_BUFFER_SIZE PATH_MAX
140 #elif defined MAXPATHLEN && MAXPATHLEN > 16384
141 #define BIG_BUFFER_SIZE MAXPATHLEN
142 #else
143 #define BIG_BUFFER_SIZE 16384
144 #endif
145
146 /* This limits the length of data returned by local_scan(). Because it is
147 written on the spool, it gets read into big_buffer. */
148
149 #define LOCAL_SCAN_MAX_RETURN (BIG_BUFFER_SIZE - 24)
150
151 /* A limit to the length of an address. RFC 2821 limits the local part to 64
152 and the domain to 255, so this should be adequate, taking into account quotings
153 etc. */
154
155 #define ADDRESS_MAXLENGTH 512
156
157 /* The length of the base names of spool files, which consist of an internal
158 message id with a trailing "-H" or "-D" added. */
159
160 #define SPOOL_NAME_LENGTH (MESSAGE_ID_LENGTH+2)
161
162 /* The maximum number of message ids to store in a waiting database
163 record. */
164
165 #define WAIT_NAME_MAX 50
166
167 /* Fixed option values for all PCRE functions */
168
169 #define PCRE_COPT 0   /* compile */
170 #define PCRE_EOPT 0   /* exec */
171
172 /* Macros for trivial functions */
173
174 #define mac_ismsgid(s) \
175   (pcre_exec(regex_ismsgid,NULL,CS s,Ustrlen(s),0,PCRE_EOPT,NULL,0) >= 0)
176
177
178 /* Options for dns_next_rr */
179
180 enum { RESET_NEXT, RESET_ANSWERS, RESET_AUTHORITY, RESET_ADDITIONAL };
181
182 /* Argument values for the time-of-day function */
183
184 enum { tod_log, tod_log_bare, tod_log_zone, tod_log_datestamp,
185        tod_zone, tod_full, tod_bsdin, tod_mbx, tod_epoch, tod_zulu };
186
187 /* For identifying types of driver */
188
189 enum {
190   DTYPE_NONE,
191   DTYPE_ROUTER,
192   DTYPE_TRANSPORT
193 };
194
195 /* Error numbers for generating error messages when reading a message on the
196 standard input. */
197
198 enum {
199   ERRMESS_BADARGADDRESS,    /* Bad address via argument list */
200   ERRMESS_BADADDRESS,       /* Bad address read via -t */
201   ERRMESS_NOADDRESS,        /* Message has no addresses */
202   ERRMESS_IGADDRESS,        /* All -t addresses ignored */
203   ERRMESS_BADNOADDRESS,     /* Bad address via -t, leaving none */
204   ERRMESS_IOERR,            /* I/O error while reading a message */
205   ERRMESS_VLONGHEADER,      /* Excessively long message header */
206   ERRMESS_VLONGHDRLINE,     /* Excessively long single line in header */
207   ERRMESS_TOOBIG,           /* Message too big */
208   ERRMESS_TOOMANYRECIP,     /* Too many recipients */
209   ERRMESS_LOCAL_SCAN,       /* Rejected by local scan */
210   ERRMESS_LOCAL_ACL         /* Rejected by non-SMTP ACL */
211 };
212
213 /* Error handling styles - set by option, and apply only when receiving
214 a local message not via SMTP. */
215
216 enum {
217   ERRORS_SENDER,            /* Return to sender (default) */
218   ERRORS_STDERR             /* Write on stderr */
219 };
220
221 /* Exec control values when Exim execs itself via child_exec_exim. */
222
223 enum {
224   CEE_RETURN_ARGV,          /* Don't exec, just build and return argv */
225   CEE_EXEC_EXIT,            /* Just exit if exec fails */
226   CEE_EXEC_PANIC            /* Panic-die if exec fails */
227 };
228
229 /* Bit values for filter_test */
230
231 #define FTEST_NONE     0    /* Not filter testing */
232 #define FTEST_USER     1    /* Testing user filter */
233 #define FTEST_SYSTEM   2    /* Testing system filter */
234
235 /* Returns from the routing, transport and authentication functions (not all
236 apply to all of them). Some other functions also use these convenient values,
237 and some additional values are used only by non-driver functions.
238
239 OK, FAIL, DEFER, ERROR, and FAIL_FORCED are also declared in local_scan.h for
240 use in the local_scan() function and in ${dlfunc loaded functions. Do not
241 change them unilaterally. */
242
243 #define  OK            0    /* Successful match */
244 #define  DEFER         1    /* Defer - some problem */
245 #define  FAIL          2    /* Matching failed */
246 #define  ERROR         3    /* Internal or config error */
247 #define  FAIL_FORCED   4    /* "Forced" failure */
248 /***********/
249 #define DECLINE        5    /* Declined to handle the address, pass to next
250                                  router unless no_more is set */
251 #define PASS           6    /* Pass to next driver, or to pass_router,
252                                  even if no_more is set */
253 #define DISCARD        7    /* Address routed to :blackhole: or "seen finish" */
254 #define SKIP           8    /* Skip this router (used in route_address only) */
255 #define REROUTED       9    /* Address was changed and child created*/
256 #define PANIC         10    /* Hard failed with internal error */
257 #define BAD64         11    /* Bad base64 data (auth) */
258 #define UNEXPECTED    12    /* Unexpected initial auth data */
259 #define CANCELLED     13    /* Authentication cancelled */
260 #define FAIL_SEND     14    /* send() failed in authenticator */
261 #define FAIL_DROP     15    /* Fail and drop connection (used in ACL) */
262
263 /* Returns from the deliver_message() function */
264
265 #define DELIVER_ATTEMPTED_NORMAL   0  /* Tried a normal delivery */
266 #define DELIVER_MUA_SUCCEEDED      1  /* Success when mua_wrapper is set */
267 #define DELIVER_MUA_FAILED         2  /* Failure when mua_wrapper is set */
268 #define DELIVER_NOT_ATTEMPTED      3  /* Not tried (no msg or is locked */
269
270 /* Returns from DNS lookup functions. */
271
272 enum { DNS_SUCCEED, DNS_NOMATCH, DNS_NODATA, DNS_AGAIN, DNS_FAIL };
273
274 /* Ending states when reading a message. The order is important. The test
275 for having to swallow the rest of an SMTP message is whether the value is
276 >= END_NOTENDED. */
277
278 #define END_NOTSTARTED 0    /* Message not started */
279 #define END_DOT        1    /* Message ended with '.' */
280 #define END_EOF        2    /* Message ended with EOF (error for SMTP) */
281 #define END_NOTENDED   3    /* Message reading not yet ended */
282 #define END_SIZE       4    /* Reading ended because message too big */
283 #define END_WERROR     5    /* Write error while reading the message */
284
285 /* Options bits for debugging; D_v and D_local_scan are also in local_scan.h */
286
287 #define D_v                          0x00000001
288 #define D_local_scan                 0x00000002
289
290 #define D_acl                        0x00000004
291 #define D_auth                       0x00000008
292 #define D_deliver                    0x00000010
293 #define D_dns                        0x00000020
294 #define D_dnsbl                      0x00000040
295 #define D_exec                       0x00000080
296 #define D_expand                     0x00000100
297 #define D_filter                     0x00000200
298 #define D_hints_lookup               0x00000400
299 #define D_host_lookup                0x00000800
300 #define D_ident                      0x00001000
301 #define D_interface                  0x00002000
302 #define D_lists                      0x00004000
303 #define D_load                       0x00008000
304 #define D_lookup                     0x00010000
305 #define D_memory                     0x00020000
306 #define D_pid                        0x00040000
307 #define D_process_info               0x00080000
308 #define D_queue_run                  0x00100000
309 #define D_receive                    0x00200000
310 #define D_resolver                   0x00400000
311 #define D_retry                      0x00800000
312 #define D_rewrite                    0x01000000
313 #define D_route                      0x02000000
314 #define D_timestamp                  0x04000000
315 #define D_tls                        0x08000000
316 #define D_transport                  0x10000000
317 #define D_uid                        0x20000000
318 #define D_verify                     0x40000000
319
320 /* The D_all value must always have all bits set, as it is recognized specially
321 by the function that decodes debug and log selectors. This is to enable it to
322 set all the bits in a multi-word selector. Debug doesn't use this yet, but we
323 are getting close. In fact, we want to omit "memory" for -d+all, but can't
324 handle this here. It is fudged externally. */
325
326 #define D_all                        0xffffffff
327
328 #define D_any                        (D_all & \
329                                        ~(D_v           | \
330                                          D_pid         | \
331                                          D_timestamp)  )
332
333 #define D_default                    (0xffffffff & \
334                                        ~(D_expand      | \
335                                          D_filter      | \
336                                          D_interface   | \
337                                          D_load        | \
338                                          D_local_scan  | \
339                                          D_memory      | \
340                                          D_pid         | \
341                                          D_timestamp   | \
342                                          D_resolver))
343
344 /* Options bits for logging. Those that will end up in log_write_selector have
345 values < 0x80000000. They can be used in calls to log_write(). The others have
346 values > 0x80000000 and are put into log_extra_selector (without the top bit).
347 These are only ever tested independently. "All" is a magic value that is used
348 only in the name table to set all options in both bit maps. */
349
350 /* The L_all value must always have all bits set, as it is recognized specially
351 by the function that decodes debug and log selectors. This is to enable it to
352 set all the bits in a multi-word selector. */
353
354 #define L_all                          0xffffffff
355
356 #define L_address_rewrite              0x00000001
357 #define L_all_parents                  0x00000002
358 #define L_connection_reject            0x00000004
359 #define L_delay_delivery               0x00000008
360 #define L_dnslist_defer                0x00000010
361 #define L_etrn                         0x00000020
362 #define L_host_lookup_failed           0x00000040
363 #define L_lost_incoming_connection     0x00000080
364 #define L_queue_run                    0x00000100
365 #define L_retry_defer                  0x00000200
366 #define L_size_reject                  0x00000400
367 #define L_skip_delivery                0x00000800
368 #define L_smtp_connection              0x00001000
369 #define L_smtp_incomplete_transaction  0x00002000
370 #define L_smtp_protocol_error          0x00004000
371 #define L_smtp_syntax_error            0x00008000
372
373 #define LX_acl_warn_skipped            0x80000001
374 #define LX_arguments                   0x80000002
375 #define LX_deliver_time                0x80000004
376 #define LX_delivery_size               0x80000008
377 #define LX_ident_timeout               0x80000010
378 #define LX_incoming_interface          0x80000020
379 #define LX_incoming_port               0x80000040
380 #define LX_outgoing_port               0x80000080
381 #define LX_pid                         0x80000100
382 #define LX_queue_time                  0x80000200
383 #define LX_queue_time_overall          0x80000400
384 #define LX_received_sender             0x80000800
385 #define LX_received_recipients         0x80001000
386 #define LX_rejected_header             0x80002000
387 #define LX_return_path_on_delivery     0x80004000
388 #define LX_sender_on_delivery          0x80008000
389 #define LX_sender_verify_fail          0x80010000
390 #define LX_smtp_confirmation           0x80020000
391 #define LX_smtp_no_mail                0x80040000
392 #define LX_subject                     0x80080000
393 #define LX_tls_certificate_verified    0x80100000
394 #define LX_tls_cipher                  0x80200000
395 #define LX_tls_peerdn                  0x80400000
396 #define LX_unknown_in_list             0x80800000
397
398 #define L_default     (L_connection_reject        | \
399                        L_delay_delivery           | \
400                        L_dnslist_defer            | \
401                        L_etrn                     | \
402                        L_host_lookup_failed       | \
403                        L_lost_incoming_connection | \
404                        L_queue_run                | \
405                        L_retry_defer              | \
406                        L_size_reject              | \
407                        L_skip_delivery)
408
409 #define LX_default   ((LX_acl_warn_skipped        | \
410                        LX_rejected_header         | \
411                        LX_sender_verify_fail      | \
412                        LX_tls_cipher) & 0x7fffffff)
413
414 /* Private error numbers for delivery failures, set negative so as not
415 to conflict with system errno values. */
416
417 #define ERRNO_UNKNOWNERROR    (-1)
418 #define ERRNO_USERSLASH       (-2)
419 #define ERRNO_EXISTRACE       (-3)
420 #define ERRNO_NOTREGULAR      (-4)
421 #define ERRNO_NOTDIRECTORY    (-5)
422 #define ERRNO_BADUGID         (-6)
423 #define ERRNO_BADMODE         (-7)
424 #define ERRNO_INODECHANGED    (-8)
425 #define ERRNO_LOCKFAILED      (-9)
426 #define ERRNO_BADADDRESS2    (-10)
427 #define ERRNO_FORBIDPIPE     (-11)
428 #define ERRNO_FORBIDFILE     (-12)
429 #define ERRNO_FORBIDREPLY    (-13)
430 #define ERRNO_MISSINGPIPE    (-14)
431 #define ERRNO_MISSINGFILE    (-15)
432 #define ERRNO_MISSINGREPLY   (-16)
433 #define ERRNO_BADREDIRECT    (-17)
434 #define ERRNO_SMTPCLOSED     (-18)
435 #define ERRNO_SMTPFORMAT     (-19)
436 #define ERRNO_SPOOLFORMAT    (-20)
437 #define ERRNO_NOTABSOLUTE    (-21)
438 #define ERRNO_EXIMQUOTA      (-22)   /* Exim-imposed quota */
439 #define ERRNO_HELD           (-23)
440 #define ERRNO_FILTER_FAIL    (-24)   /* Delivery filter process failure */
441 #define ERRNO_CHHEADER_FAIL  (-25)   /* Delivery add/remove header failure */
442 #define ERRNO_WRITEINCOMPLETE (-26)  /* Delivery write incomplete error */
443 #define ERRNO_EXPANDFAIL     (-27)   /* Some expansion failed */
444 #define ERRNO_GIDFAIL        (-28)   /* Failed to get gid */
445 #define ERRNO_UIDFAIL        (-29)   /* Failed to get uid */
446 #define ERRNO_BADTRANSPORT   (-30)   /* Unset or non-existent transport */
447 #define ERRNO_MBXLENGTH      (-31)   /* MBX length mismatch */
448 #define ERRNO_UNKNOWNHOST    (-32)   /* Lookup failed in smtp transport */
449 #define ERRNO_FORMATUNKNOWN  (-33)   /* Can't match format in appendfile */
450 #define ERRNO_BADCREATE      (-34)   /* Creation outside home in appendfile */
451 #define ERRNO_LISTDEFER      (-35)   /* Can't check a list; lookup defer */
452 #define ERRNO_DNSDEFER       (-36)   /* DNS lookup defer */
453 #define ERRNO_TLSFAILURE     (-37)   /* Failed to start TLS session */
454 #define ERRNO_TLSREQUIRED    (-38)   /* Mandatory TLS session not started */
455 #define ERRNO_CHOWNFAIL      (-39)   /* Failed to chown a file */
456 #define ERRNO_PIPEFAIL       (-40)   /* Failed to create a pipe */
457 #define ERRNO_CALLOUTDEFER   (-41)   /* When verifying */
458 #define ERRNO_AUTHFAIL       (-42)   /* When required by client */
459 #define ERRNO_CONNECTTIMEOUT (-43)   /* Used internally in smtp transport */
460 #define ERRNO_RCPT4XX        (-44)   /* RCPT gave 4xx error */
461 #define ERRNO_MAIL4XX        (-45)   /* MAIL gave 4xx error */
462 #define ERRNO_DATA4XX        (-46)   /* DATA gave 4xx error */
463
464 /* These must be last, so all retry deferments can easily be identified */
465
466 #define ERRNO_RETRY_BASE     (-51)   /* Base to test against */
467 #define ERRNO_RRETRY         (-51)   /* Not time for routing */
468 #define ERRNO_LRETRY         (-52)   /* Not time for local delivery */
469 #define ERRNO_HRETRY         (-53)   /* Not time for any remote host */
470 #define ERRNO_LOCAL_ONLY     (-54)   /* Local-only delivery */
471 #define ERRNO_QUEUE_DOMAIN   (-55)   /* Domain in queue_domains */
472
473 /* Special actions to take after failure or deferment. */
474
475 enum {
476   SPECIAL_NONE,             /* No special action */
477   SPECIAL_FREEZE,           /* Freeze message */
478   SPECIAL_FAIL,             /* Fail the delivery */
479   SPECIAL_WARN              /* Send a warning message */
480 };
481
482 /* Flags that get ORed into the more_errno field of an address to give more
483 information about errors for retry purposes. They are greater than 256, because
484 the bottom byte contains 'A' or 'M' for remote addresses, to indicate whether
485 the name was looked up only via an address record or whether MX records were
486 used, respectively. */
487
488 #define RTEF_CTOUT     0x0100      /* Connection timed out */
489
490 /* Permission and other options for parse_extract_addresses(),
491 filter_interpret(), and rda_interpret(), i.e. what special things are allowed
492 in redirection operations. Not all apply to all cases. Some of the bits allow
493 and some forbid, reflecting the "allow" and "forbid" options in the redirect
494 router, which were chosen to represent the standard situation for users'
495 .forward files. */
496
497 #define RDO_BLACKHOLE    0x00000001  /* Forbid :blackhole: */
498 #define RDO_DEFER        0x00000002  /* Allow :defer: or "defer" */
499 #define RDO_EACCES       0x00000004  /* Ignore EACCES */
500 #define RDO_ENOTDIR      0x00000008  /* Ignore ENOTDIR */
501 #define RDO_EXISTS       0x00000010  /* Forbid "exists" in expansion in filter */
502 #define RDO_FAIL         0x00000020  /* Allow :fail: or "fail" */
503 #define RDO_FILTER       0x00000040  /* Allow a filter script */
504 #define RDO_FREEZE       0x00000080  /* Allow "freeze" */
505 #define RDO_INCLUDE      0x00000100  /* Forbid :include: */
506 #define RDO_LOG          0x00000200  /* Forbid "log" */
507 #define RDO_LOOKUP       0x00000400  /* Forbid "lookup" in expansion in filter */
508 #define RDO_PERL         0x00000800  /* Forbid "perl" in expansion in filter */
509 #define RDO_READFILE     0x00001000  /* Forbid "readfile" in exp in filter */
510 #define RDO_READSOCK     0x00002000  /* Forbid "readsocket" in exp in filter */
511 #define RDO_RUN          0x00004000  /* Forbid "run" in expansion in filter */
512 #define RDO_DLFUNC       0x00008000  /* Forbid "dlfunc" in expansion in filter */
513 #define RDO_REALLOG      0x00010000  /* Really do log (not testing/verifying) */
514 #define RDO_REWRITE      0x00020000  /* Rewrite generated addresses */
515 #define RDO_EXIM_FILTER  0x00040000  /* Forbid Exim filters */
516 #define RDO_SIEVE_FILTER 0x00080000  /* Forbid Sieve filters */
517 #define RDO_PREPEND_HOME 0x00100000  /* Prepend $home to relative paths in Exim filter save commands */
518
519 /* This is the set that apply to expansions in filters */
520
521 #define RDO_FILTER_EXPANSIONS \
522   (RDO_EXISTS|RDO_LOOKUP|RDO_PERL|RDO_READFILE|RDO_READSOCK|RDO_RUN|RDO_DLFUNC)
523
524 /* As well as the RDO bits themselves, we need the bit numbers in order to
525 access (most of) the individual bits as separate options. This could be
526 automated, but I haven't bothered. Keep this list in step with the above! */
527
528 enum { RDON_BLACKHOLE, RDON_DEFER, RDON_EACCES, RDON_ENOTDIR, RDON_EXISTS,
529   RDON_FAIL, RDON_FILTER, RDON_FREEZE, RDON_INCLUDE, RDON_LOG, RDON_LOOKUP,
530   RDON_PERL, RDON_READFILE, RDON_READSOCK, RDON_RUN, RDON_DLFUNC, RDON_REALLOG,
531   RDON_REWRITE, RDON_EXIM_FILTER, RDON_SIEVE_FILTER, RDON_PREPEND_HOME };
532
533 /* Results of filter or forward file processing. Some are only from a filter;
534 some are only from a forward file. */
535
536 enum {
537   FF_DELIVERED,         /* Success, took significant action */
538   FF_NOTDELIVERED,      /* Success, didn't take significant action */
539   FF_BLACKHOLE,         /* Blackholing requested */
540   FF_DEFER,             /* Defer requested */
541   FF_FAIL,              /* Fail requested */
542   FF_INCLUDEFAIL,       /* :include: failed */
543   FF_NONEXIST,          /* Forward file does not exist */
544   FF_FREEZE,            /* Freeze requested */
545   FF_ERROR              /* We have a problem */
546 };
547
548 /* Values for identifying particular headers; printing characters are used, so
549 they can be read in the spool file for those headers that are permanently
550 marked. The lower case values don't get onto the spool; they are used only as
551 return values from header_checkname(). */
552
553 #define htype_other         ' '   /* Unspecified header */
554 #define htype_from          'F'
555 #define htype_to            'T'
556 #define htype_cc            'C'
557 #define htype_bcc           'B'
558 #define htype_id            'I'   /* for message-id */
559 #define htype_reply_to      'R'
560 #define htype_received      'P'   /* P for Postmark */
561 #define htype_sender        'S'
562 #define htype_old           '*'   /* Replaced header */
563
564 #define htype_date          'd'
565 #define htype_return_path   'p'
566 #define htype_delivery_date 'x'
567 #define htype_envelope_to   'e'
568 #define htype_subject       's'
569
570 /* These values are used only when adding new headers from an ACL; they too
571 never get onto the spool. The type of the added header is set by reference
572 to the header name, by calling header_checkname(). */
573
574 #define htype_add_top       'a'
575 #define htype_add_rec       'r'
576 #define htype_add_bot       'z'
577 #define htype_add_rfc       'f'
578
579 /* Types of item in options lists. These are the bottom 8 bits of the "type"
580 field, which is an int. The opt_void value is used for entries in tables that
581 point to special types of value that are accessed only indirectly (e.g. the
582 rewrite data that is built out of a string option.) We need to have some values
583 visible in local_scan, so the following are declared there:
584
585   opt_stringptr, opt_int, opt_octint, opt_mkint, opt_Kint, opt_fixed, opt_time,
586   opt_bool
587
588 To make sure we don't conflict, the local_scan.h values start from zero, and
589 those defined here start from 32. The boolean ones must all be together so they
590 can be easily tested as a group. That is the only use of opt_bool_last. */
591
592 enum { opt_bit = 32, opt_bool_verify, opt_bool_set, opt_expand_bool,
593   opt_bool_last,
594   opt_rewrite, opt_timelist, opt_uid, opt_gid, opt_uidlist, opt_gidlist,
595   opt_expand_uid, opt_expand_gid, opt_void };
596
597 /* There's a high-ish bit which is used to flag duplicate options, kept
598 for compatibility, which shouldn't be output. Also used for hidden options
599 that are automatically maintained from others. Another high bit is used to
600 flag driver options that although private (so as to be settable only on some
601 drivers), are stored in the instance block so as to be accessible from outside.
602 A third high bit is set when an option is read, so as to be able to give an
603 error if any option is set twice. Finally, there's a bit which is set when an
604 option is set with the "hide" prefix, to prevent -bP from showing it to
605 non-admin callers. The next byte up in the int is used to keep the bit number
606 for booleans that are kept in one bit. */
607
608 #define opt_hidden  0x100      /* Private to Exim */
609 #define opt_public  0x200      /* Stored in the main instance block */
610 #define opt_set     0x400      /* Option is set */
611 #define opt_secure  0x800      /* "hide" prefix used */
612 #define opt_mask    0x0ff
613
614 /* Verify types when directing and routing */
615
616 enum { v_none, v_sender, v_recipient, v_expn };
617
618 /* Option flags for verify_address() */
619
620 #define vopt_fake_sender          0x0001   /* for verify=sender=<address> */
621 #define vopt_is_recipient         0x0002
622 #define vopt_qualify              0x0004
623 #define vopt_expn                 0x0008
624 #define vopt_callout_fullpm       0x0010   /* full postmaster during callout */
625 #define vopt_callout_random       0x0020   /* during callout */
626 #define vopt_callout_no_cache     0x0040   /* disable callout cache */
627 #define vopt_callout_recipsender  0x0080   /* use real sender to verify recip */
628 #define vopt_callout_recippmaster 0x0100   /* use postmaster to verify recip */
629 #define vopt_success_on_redirect  0x0200
630
631 /* Values for fields in callout cache records */
632
633 #define ccache_unknown         0       /* test hasn't been done */
634 #define ccache_accept          1
635 #define ccache_reject          2       /* All rejections except */
636 #define ccache_reject_mfnull   3       /* MAIL FROM:<> was rejected */
637
638 /* Options for lookup functions */
639
640 #define lookup_querystyle      1    /* query-style lookup */
641 #define lookup_absfile         2    /* requires absolute file name */
642 #define lookup_absfilequery    4    /* query-style starts with file name */
643
644 /* Status values for host_item blocks. Require hstatus_unusable and
645 hstatus_unusable_expired to be last. */
646
647 enum { hstatus_unknown, hstatus_usable, hstatus_unusable,
648        hstatus_unusable_expired };
649
650 /* Reasons why a host is unusable (for clearer log messages) */
651
652 enum { hwhy_unknown, hwhy_retry, hwhy_failed, hwhy_deferred, hwhy_ignored };
653
654 /* Domain lookup types for routers */
655
656 enum { lk_default, lk_byname, lk_bydns };
657
658 /* Values for the self_code fields */
659
660 enum { self_freeze, self_defer, self_send, self_reroute, self_pass, self_fail };
661
662 /* Flags for rewrite rules */
663
664 #define rewrite_sender       0x0001
665 #define rewrite_from         0x0002
666 #define rewrite_to           0x0004
667 #define rewrite_cc           0x0008
668 #define rewrite_bcc          0x0010
669 #define rewrite_replyto      0x0020
670 #define rewrite_all_headers  0x003F  /* all header flags */
671
672 #define rewrite_envfrom      0x0040
673 #define rewrite_envto        0x0080
674 #define rewrite_all_envelope 0x00C0  /* all envelope flags */
675
676 #define rewrite_all      (rewrite_all_headers | rewrite_all_envelope)
677
678 #define rewrite_smtp         0x0100  /* rewrite at SMTP time */
679 #define rewrite_smtp_sender  0x0200  /* SMTP sender rewrite (allows <>) */
680 #define rewrite_qualify      0x0400  /* qualify if necessary */
681 #define rewrite_repeat       0x0800  /* repeat rewrite rule */
682
683 #define rewrite_whole        0x1000  /* option bit for headers */
684 #define rewrite_quit         0x2000  /* "no more" option */
685
686 /* Flags for log_write(); LOG_MAIN, LOG_PANIC, and LOG_REJECT are also in
687 local_scan.h */
688
689 #define LOG_MAIN           1      /* Write to the main log */
690 #define LOG_PANIC          2      /* Write to the panic log */
691 #define LOG_PANIC_DIE      6      /* Write to the panic log and then die */
692 #define LOG_PROCESS        8      /* Write to the process log */
693 #define LOG_REJECT        16      /* Write to the reject log, with headers */
694 #define LOG_SENDER        32      /* Add raw sender to the message */
695 #define LOG_RECIPIENTS    64      /* Add raw recipients to the message */
696 #define LOG_CONFIG       128      /* Add "Exim configuration error" */
697 #define LOG_CONFIG_FOR  (256+128) /* Add " for" instead of ":\n" */
698 #define LOG_CONFIG_IN   (512+128) /* Add " in line x[ of file y]" */
699
700 /* SMTP command identifiers for the smtp_connection_had field that records the
701 most recent SMTP commands. Must be kept in step with the list of names in
702 smtp_in.c that is used for creating the smtp_no_mail logging action. SCH_NONE
703 is "empty". */
704
705 enum { SCH_NONE, SCH_AUTH, SCH_DATA, SCH_EHLO, SCH_ETRN, SCH_EXPN, SCH_HELO,
706        SCH_HELP, SCH_MAIL, SCH_NOOP, SCH_QUIT, SCH_RCPT, SCH_RSET, SCH_STARTTLS,
707        SCH_VRFY };
708
709 /* Returns from host_find_by{name,dns}() */
710
711 enum {
712   HOST_FIND_FAILED,     /* failed to find the host */
713   HOST_FIND_AGAIN,      /* could not resolve at this time */
714   HOST_FOUND,           /* found host */
715   HOST_FOUND_LOCAL,     /* found, but MX points to local host */
716   HOST_IGNORED          /* found but ignored - used internally only */
717 };
718
719 /* Flags for host_find_bydns() */
720
721 #define HOST_FIND_BY_SRV          0x0001
722 #define HOST_FIND_BY_MX           0x0002
723 #define HOST_FIND_BY_A            0x0004
724 #define HOST_FIND_QUALIFY_SINGLE  0x0008
725 #define HOST_FIND_SEARCH_PARENTS  0x0010
726
727 /* Actions applied to specific messages. */
728
729 enum { MSG_DELIVER, MSG_FREEZE, MSG_REMOVE, MSG_THAW, MSG_ADD_RECIPIENT,
730        MSG_MARK_ALL_DELIVERED, MSG_MARK_DELIVERED, MSG_EDIT_SENDER,
731        MSG_SHOW_BODY, MSG_SHOW_HEADER, MSG_SHOW_LOG, MSG_LOAD };
732
733 /* Returns from the spool_read_header() function */
734
735 enum {
736   spool_read_OK,        /* success */
737   spool_read_notopen,   /* open failed */
738   spool_read_enverror,  /* error in the envelope */
739   spool_read_hdrerror   /* error in the headers */
740 };
741
742 /* Options for transport_write_message */
743
744 #define topt_add_return_path    0x001
745 #define topt_add_delivery_date  0x002
746 #define topt_add_envelope_to    0x004
747 #define topt_use_crlf           0x008  /* Terminate lines with CRLF */
748 #define topt_end_dot            0x010  /* Send terminting dot line */
749 #define topt_no_headers         0x020  /* Omit headers */
750 #define topt_no_body            0x040  /* Omit body */
751 #define topt_escape_headers     0x080  /* Apply escape check to headers */
752
753 /* Codes for the host_find_failed option. */
754
755 #define hff_freeze   0
756 #define hff_defer    1
757 #define hff_pass     2
758 #define hff_decline  3
759 #define hff_fail     4
760
761 /* Router information flags */
762
763 #define ri_yestransport    0x0001    /* Must have a transport */
764 #define ri_notransport     0x0002    /* Must not have a transport */
765
766 /* Codes for match types in match_check_list; to any of them, MCL_NOEXPAND may
767 be added */
768
769 #define MCL_NOEXPAND  16
770
771 enum { MCL_STRING, MCL_DOMAIN, MCL_HOST, MCL_ADDRESS, MCL_LOCALPART };
772
773 /* Codes for the places from which ACLs can be called. These are cunningly
774 ordered to make it easy to implement tests for certain ACLs when processing
775 "control" modifiers, by means of a maximum "where" value. Do not modify this
776 order without checking carefully!
777
778 **** IMPORTANT***
779 ****   Furthermore, remember to keep these in step with the tables
780 ****   of names and response codes in globals.c.
781 **** IMPORTANT ****
782 */
783
784 enum { ACL_WHERE_RCPT,       /* Some controls are for RCPT only */
785        ACL_WHERE_MAIL,       /* )                                           */
786        ACL_WHERE_PREDATA,    /* ) There are several tests for "in message", */
787        ACL_WHERE_MIME,       /* ) implemented by <= WHERE_NOTSMTP           */
788        ACL_WHERE_DATA,       /* )                                           */
789        ACL_WHERE_NOTSMTP,    /* )                                           */
790
791        ACL_WHERE_AUTH,       /* These remaining ones are not currently    */
792        ACL_WHERE_CONNECT,    /* required to be in a special order so they */
793        ACL_WHERE_ETRN,       /* are just alphabetical.                    */
794        ACL_WHERE_EXPN,
795        ACL_WHERE_HELO,
796        ACL_WHERE_MAILAUTH,
797        ACL_WHERE_NOTSMTP_START,
798        ACL_WHERE_QUIT,
799        ACL_WHERE_STARTTLS,
800        ACL_WHERE_VRFY
801      };
802
803 /* Situations for spool_write_header() */
804
805 enum { SW_RECEIVING, SW_DELIVERING, SW_MODIFYING };
806
807 /* MX fields for hosts not obtained from MX records are always negative.
808 MX_NONE is the default case; lesser values are used when the hosts are
809 randomized in batches. */
810
811 #define MX_NONE           (-1)
812
813 /* host_item.port defaults to PORT_NONE; the only current case where this
814 is changed before running the transport is when an dnslookup router sets an
815 explicit port number. */
816
817 #define PORT_NONE     (-1)
818
819 /* Flags for single-key search defaults */
820
821 #define SEARCH_STAR       0x01
822 #define SEARCH_STARAT     0x02
823
824 /* Filter types */
825
826 enum { FILTER_UNSET, FILTER_FORWARD, FILTER_EXIM, FILTER_SIEVE };
827
828 /* End of macros.h */