src/src/local_scan.h

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