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