src/src/local_scan.h

   1 /* $Cambridge: exim/src/src/local_scan.h,v 1.5 2005/08/22 10:49:04 ph10 Exp $ */
   2
   3 /*************************************************
   4 *     Exim - an Internet mail transport agent    *
   5 *************************************************/
   6
   7 /* Copyright (c) University of Cambridge 1995 - 2005 */
   8 /* See the file NOTICE for conditions of use and distribution. */
   9
  10 /* This file is the header that is the only Exim header to be included in the
  11 source for the local_scan.c() function. It contains definitions that are made
  12 available for use in that function, and which are documented.
  13
  14 This API is also used for functions called by the ${dlfunc expansion item. */
  15
  16
  17 /* Some basic types that make some things easier, the Exim configuration
  18 settings, and the store functions. */
  19
  20 #include <sys/types.h>
  21 #include "config.h"
  22 #include "mytypes.h"
  23 #include "store.h"
  24
  25
  26 /* The function and its return codes. */
  27
  28 extern int local_scan(int, uschar **);
  29
  30 enum {
  31   LOCAL_SCAN_ACCEPT,              /* Accept */
  32   LOCAL_SCAN_ACCEPT_FREEZE,       /* Accept, but freeze */
  33   LOCAL_SCAN_ACCEPT_QUEUE,        /* Accept, but no immediate delivery */
  34   LOCAL_SCAN_REJECT,              /* Permanent rejection */
  35   LOCAL_SCAN_REJECT_NOLOGHDR,     /* Permanent rejection, no log header */
  36   LOCAL_SCAN_TEMPREJECT,          /* Temporary rejection */
  37   LOCAL_SCAN_TEMPREJECT_NOLOGHDR  /* Temporary rejection, no log header */
  38 };
  39
  40
  41 /* Functions called by ${dlfunc{file}{func}{arg}...} return one of the five
  42 status codes defined immediately below. The function's first argument is either
  43 the result of expansion, or the error message in case of failure. The second
  44 and third arguments are standard argument count and vector, comprising the
  45 {arg} values specified in the expansion item. */
  46
  47 typedef int exim_dlfunc_t(uschar **yield, int argc, uschar *argv[]);
  48
  49
  50 /* Return codes from the support functions lss_match_xxx(). These are also the
  51 codes that dynamically-loaded ${dlfunc functions must return. */
  52
  53 #define  OK            0          /* Successful match */
  54 #define  DEFER         1          /* Defer - some problem */
  55 #define  FAIL          2          /* Matching failed */
  56 #define  ERROR         3          /* Internal or config error */
  57
  58 /* Extra return code for ${dlfunc functions */
  59
  60 #define  FAIL_FORCED   4          /* "Forced" failure */
  61
  62
  63 /* Available logging destinations */
  64
  65 #define LOG_MAIN        1    /* Write to the main log */
  66 #define LOG_PANIC       2    /* Write to the panic log */
  67 #define LOG_REJECT     16    /* Write to the reject log, with headers */
  68
  69
  70 /* Accessible debugging bits */
  71
  72 #define D_v                          0x00000001
  73 #define D_local_scan                 0x00000002
  74
  75
  76 /* Option types that can be used for local_scan_options. The boolean ones
  77 MUST be last so that they are contiguous with the internal boolean specials. */
  78
  79 enum { opt_stringptr, opt_int, opt_octint, opt_mkint, opt_Kint, opt_fixed,
  80   opt_time, opt_bool };
  81
  82
  83 /* The length of message identification strings. This is the id used internally
  84 by exim. The external version for use in Received: strings has a leading 'E'
  85 added to ensure it starts with a letter. */
  86
  87 #define MESSAGE_ID_LENGTH 16
  88
  89 /* The offset to the start of the data in the data file - this allows for
  90 the name of the data file to be present in the first line. */
  91
  92 #define SPOOL_DATA_START_OFFSET (MESSAGE_ID_LENGTH+3)
  93
  94 /* Some people (Marc Merlin et al) are maintaining a patch that allows for
  95 dynamic local_scan() libraries. This code is not yet in Exim proper, but it
  96 helps the maintainers if we keep their ABI version numbers here. This may
  97 mutate into more general support later. The major number is increased when the
  98 ABI is changed in a non backward compatible way. The minor number is increased
  99 each time a new feature is added (in a way that doesn't break backward
 100 compatibility). */
 101
 102 #define LOCAL_SCAN_ABI_VERSION_MAJOR 1
 103 #define LOCAL_SCAN_ABI_VERSION_MINOR 0
 104
 105 /* Structure definitions that are documented as visible in the function. */
 106
 107 typedef struct header_line {
 108   struct header_line *next;
 109   int    type;
 110   int    slen;
 111   uschar *text;
 112 } header_line;
 113
 114 /* Entries in lists options are in this form. */
 115
 116 typedef struct {
 117   char   *name;
 118   int     type;
 119   void   *value;
 120 } optionlist;
 121
 122 /*Structure for holding information about an envelope address. The errors_to
 123 field is always NULL except for one_time aliases that had errors_to on the
 124 routers that generated them. */
 125
 126 typedef struct recipient_item {
 127   uschar *address;              /* the recipient address */
 128   int     pno;                  /* parent number for "one_time" alias, or -1 */
 129   uschar *errors_to;            /* the errors_to address or NULL */
 130 #ifdef EXPERIMENTAL_BRIGHTMAIL
 131   uschar *bmi_optin;
 132 #endif
 133 } recipient_item;
 134
 135
 136 /* Global variables that are documented as visible in the function. */
 137
 138 extern unsigned int debug_selector;    /* Debugging bits */
 139
 140 extern uschar *expand_string_message;  /* Error info for failing expansion */
 141 extern uschar *headers_charset;        /* Charset for RFC 2047 decoding */
 142 extern header_line *header_last;       /* Final header */
 143 extern header_line *header_list;       /* First header */
 144 extern BOOL    host_checking;          /* Set when checking a host */
 145 extern uschar *interface_address;      /* Interface for incoming call */
 146 extern int     interface_port;         /* Port number for incoming call */
 147 extern uschar *message_id;             /* Internal id of message being handled */
 148 extern uschar *received_protocol;      /* Name of incoming protocol */
 149 extern int     recipients_count;       /* Number of recipients */
 150 extern recipient_item *recipients_list;/* List of recipient addresses */
 151 extern unsigned char *sender_address;  /* Sender address */
 152 extern uschar *sender_host_address;    /* IP address of sender, as chars */
 153 extern uschar *sender_host_authenticated; /* Name of authentication mechanism */
 154 extern uschar *sender_host_name;       /* Host name from lookup */
 155 extern int     sender_host_port;       /* Port number of sender */
 156 extern BOOL    smtp_batched_input;     /* TRUE if SMTP batch (no interaction) */
 157 extern BOOL    smtp_input;             /* TRUE if input is via SMTP */
 158
 159
 160 /* Functions that are documented as visible in local_scan(). */
 161
 162 extern int     child_close(pid_t, int);
 163 extern pid_t   child_open(uschar **, uschar **, int, int *, int *, BOOL);
 164 extern pid_t   child_open_exim(int *);
 165 extern void    debug_printf(char *, ...) PRINTF_FUNCTION;
 166 extern uschar *expand_string(uschar *);
 167 extern void    header_add(int, char *, ...);
 168 extern void    header_add_at_position(BOOL, uschar *, BOOL, int, char *, ...);
 169 extern void    header_remove(int, uschar *);
 170 extern BOOL    header_testname(header_line *, uschar *, int, BOOL);
 171 extern BOOL    header_testname_incomplete(header_line *, uschar *, int, BOOL);
 172 extern void    log_write(unsigned int, int, char *format, ...);
 173 extern int     lss_b64decode(uschar *, uschar **);
 174 extern uschar *lss_b64encode(uschar *, int);
 175 extern int     lss_match_domain(uschar *, uschar *);
 176 extern int     lss_match_local_part(uschar *, uschar *, BOOL);
 177 extern int     lss_match_address(uschar *, uschar *, BOOL);
 178 extern int     lss_match_host(uschar *, uschar *, uschar *);
 179 extern void    receive_add_recipient(uschar *, int);
 180 extern BOOL    receive_remove_recipient(uschar *);
 181 extern uschar *rfc2047_decode(uschar *, BOOL, uschar *, int, int *, uschar **);
 182 extern int     smtp_fflush(void);
 183 extern void    smtp_printf(char *, ...) PRINTF_FUNCTION;
 184 extern uschar *string_copy(uschar *);
 185 extern uschar *string_copyn(uschar *, int);
 186 extern uschar *string_sprintf(char *, ...);
 187
 188 /* End of local_scan.h */