src/src/macros.h

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