src/src/macros.h

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