src/src/functions.h

   1 /* $Cambridge: exim/src/src/functions.h,v 1.30 2006/10/24 12:56:06 ph10 Exp $ */
   2
   3 /*************************************************
   4 *     Exim - an Internet mail transport agent    *
   5 *************************************************/
   6
   7 /* Copyright (c) University of Cambridge 1995 - 2006 */
   8 /* See the file NOTICE for conditions of use and distribution. */
   9
  10
  11 /* Prototypes for functions that appear in various modules. Gathered together
  12 to avoid having a lot of tiddly little headers with only a couple of lines in
  13 them. However, some functions that are used (or not used) by utility programs
  14 are in in fact in separate headers. */
  15
  16
  17 #ifdef EXIM_PERL
  18 extern uschar *call_perl_cat(uschar *, int *, int *, uschar **, uschar *,
  19                  uschar **);
  20 extern void    cleanup_perl(void);
  21 extern uschar *init_perl(uschar *);
  22 #endif
  23
  24
  25 #ifdef SUPPORT_TLS
  26 extern int     tls_client_start(int, host_item *, address_item *, uschar *,
  27                  uschar *, uschar *, uschar *, uschar *, uschar *, int);
  28 extern void    tls_close(BOOL);
  29 extern int     tls_feof(void);
  30 extern int     tls_ferror(void);
  31 extern int     tls_getc(void);
  32 extern int     tls_read(uschar *, size_t);
  33 extern int     tls_server_start(uschar *);
  34 extern int     tls_ungetc(int);
  35 extern int     tls_write(const uschar *, size_t);
  36 #endif
  37
  38
  39 /* Everything else... */
  40
  41 extern acl_block *acl_read(uschar *(*)(void), uschar **);
  42 extern int     acl_check(int, uschar *, uschar *, uschar **, uschar **);
  43 extern tree_node *acl_var_create(uschar *);
  44 extern void    acl_var_write(uschar *, uschar *, void *);
  45 extern uschar *auth_b64encode(uschar *, int);
  46 extern int     auth_b64decode(uschar *, uschar **);
  47 extern int     auth_call_pam(uschar *, uschar **);
  48 extern int     auth_call_pwcheck(uschar *, uschar **);
  49 extern int     auth_call_radius(uschar *, uschar **);
  50 extern int     auth_call_saslauthd(uschar *, uschar *, uschar *, uschar *,
  51                  uschar **);
  52 extern int     auth_check_serv_cond(auth_instance *);
  53 extern int     auth_get_data(uschar **, uschar *, int);
  54 extern int     auth_get_no64_data(uschar **, uschar *);
  55 extern uschar *auth_xtextencode(uschar *, int);
  56 extern int     auth_xtextdecode(uschar *, uschar **);
  57
  58 extern int     check_host(void *, uschar *, uschar **, uschar **);
  59 extern uschar **child_exec_exim(int, BOOL, int *, BOOL, int, ...);
  60 extern pid_t   child_open_uid(uschar **, uschar **, int, uid_t *, gid_t *,
  61                  int *, int *, uschar *, BOOL);
  62
  63 extern void    daemon_go(void);
  64 extern void    debug_print_argv(uschar **);
  65 extern void    debug_print_ids(uschar *);
  66 extern void    debug_print_string(uschar *);
  67 extern void    debug_print_tree(tree_node *);
  68 extern void    debug_vprintf(char *, va_list);
  69 extern address_item *deliver_make_addr(uschar *, BOOL);
  70 extern int     deliver_message(uschar *, BOOL, BOOL);
  71 extern void    deliver_msglog(const char *, ...);
  72 extern void    deliver_set_expansions(address_item *);
  73 extern int     deliver_split_address(address_item *);
  74 extern void    deliver_succeeded(address_item *);
  75 #ifdef WITH_OLD_DEMIME
  76 extern int     demime(uschar **);
  77 #endif
  78 extern BOOL    directory_make(uschar *, uschar *, int, BOOL);
  79 #ifdef EXPERIMENTAL_DOMAINKEYS
  80 extern BOOL    dk_transport_write_message(address_item *, int, int,
  81                    int, uschar *, uschar *, uschar *, uschar *, rewrite_rule *,
  82                    int, uschar *, uschar *, uschar *, uschar *, uschar *, uschar *);
  83 #endif
  84 extern dns_address *dns_address_from_rr(dns_answer *, dns_record *);
  85 extern void    dns_build_reverse(uschar *, uschar *);
  86 extern void    dns_init(BOOL, BOOL);
  87 extern int     dns_basic_lookup(dns_answer *, uschar *, int);
  88 extern int     dns_lookup(dns_answer *, uschar *, int, uschar **);
  89 extern int     dns_special_lookup(dns_answer *, uschar *, int, uschar **);
  90 extern dns_record *dns_next_rr(dns_answer *, dns_scan *, int);
  91 extern uschar *dns_text_type(int);
  92
  93 extern void    enq_end(uschar *);
  94 extern BOOL    enq_start(uschar *);
  95 extern void    exim_exit(int);
  96 extern void    exim_nullstd(void);
  97 extern void    exim_setugid(uid_t, gid_t, BOOL, uschar *);
  98 extern int     exim_tvcmp(struct timeval *, struct timeval *);
  99 extern void    exim_wait_tick(struct timeval *, int);
 100 extern BOOL    expand_check_condition(uschar *, uschar *, uschar *);
 101 extern uschar *expand_string(uschar *);
 102 extern uschar *expand_string_copy(uschar *);
 103 extern int     expand_string_integer(uschar *, BOOL);
 104
 105 extern int     filter_interpret(uschar *, int, address_item **, uschar **);
 106 extern BOOL    filter_personal(string_item *, BOOL);
 107 extern BOOL    filter_runtest(int, uschar *, BOOL, BOOL);
 108 extern BOOL    filter_system_interpret(address_item **, uschar **);
 109
 110 extern void    header_add(int, char *, ...);
 111 extern int     header_checkname(header_line *, BOOL);
 112 extern BOOL    header_match(uschar *, BOOL, BOOL, string_item *, int, ...);
 113 extern int     host_address_extract_port(uschar *);
 114 extern uschar *host_and_ident(BOOL);
 115 extern int     host_aton(uschar *, int *);
 116 extern void    host_build_hostlist(host_item **, uschar *, BOOL);
 117 extern ip_address_item *host_build_ifacelist(uschar *, uschar *);
 118 extern void    host_build_log_info(void);
 119 extern void    host_build_sender_fullhost(void);
 120 extern BOOL    host_find_byname(host_item *, uschar *, int, uschar **, BOOL);
 121 extern int     host_find_bydns(host_item *, uschar *, int, uschar *, uschar *,
 122                  uschar *,uschar **, BOOL *);
 123 extern ip_address_item *host_find_interfaces(void);
 124 extern BOOL    host_is_in_net(uschar *, uschar *, int);
 125 extern BOOL    host_is_tls_on_connect_port(int);
 126 extern int     host_item_get_port(host_item *);
 127 extern void    host_mask(int, int *, int);
 128 extern int     host_name_lookup(void);
 129 extern int     host_nmtoa(int, int *, int, uschar *, int);
 130 extern uschar *host_ntoa(int, const void *, uschar *, int *);
 131 extern int     host_scan_for_local_hosts(host_item *, host_item **, BOOL *);
 132
 133 extern int     ip_bind(int, int, uschar *, int);
 134 extern int     ip_connect(int, int, uschar *, int, int);
 135 extern void    ip_keepalive(int, uschar *, BOOL);
 136 extern int     ip_recv(int, uschar *, int, int);
 137 extern int     ip_socket(int, int);
 138
 139 extern uschar *local_part_quote(uschar *lpart);
 140 extern void    log_close_all(void);
 141
 142 #ifdef WITH_CONTENT_SCAN
 143 extern int     malware(uschar **);
 144 #endif
 145 extern int     match_address_list(uschar *, BOOL, BOOL, uschar **,
 146                  unsigned int *, int, int, uschar **);
 147 extern int     match_check_list(uschar **, int, tree_node **, unsigned int **,
 148                  int(*)(void *, uschar *, uschar **, uschar **), void *, int,
 149                  uschar *, uschar **);
 150 extern int     match_isinlist(uschar *, uschar **, int, tree_node **,
 151                  unsigned int *, int, BOOL, uschar **);
 152 extern int     match_check_string(uschar *, uschar *, int, BOOL, BOOL, BOOL,
 153                  uschar **);
 154 extern void    md5_end(md5 *, const uschar *, int, uschar *);
 155 extern void    md5_mid(md5 *, const uschar *);
 156 extern void    md5_start(md5 *);
 157 extern void    millisleep(int);
 158 #ifdef WITH_CONTENT_SCAN
 159 struct mime_boundary_context;
 160 extern int     mime_acl_check(uschar *acl, FILE *f,
 161                  struct mime_boundary_context *, uschar **, uschar **);
 162 extern int     mime_decode(uschar **);
 163 extern int     mime_regex(uschar **);
 164 #endif
 165 extern uschar *moan_check_errorcopy(uschar *);
 166 extern BOOL    moan_skipped_syntax_errors(uschar *, error_block *, uschar *,
 167                  BOOL, uschar *);
 168 extern void    moan_smtp_batch(uschar *, char *, ...);
 169 extern void    moan_tell_someone(uschar *, address_item *, uschar *, char *,
 170                  ...);
 171 extern BOOL    moan_to_sender(int, error_block *, header_line *, FILE *, BOOL);
 172 extern FILE   *modefopen(uschar *, char *, mode_t);
 173
 174 extern uschar *parse_extract_address(uschar *, uschar **, int *, int *, int *,
 175                  BOOL);
 176 extern int     parse_forward_list(uschar *, int, address_item **, uschar **,
 177                  uschar *, uschar *, error_block **);
 178 extern uschar *parse_find_address_end(uschar *, BOOL);
 179 extern uschar *parse_find_at(uschar *);
 180 extern uschar *parse_fix_phrase(uschar *, int, uschar *, int);
 181 extern uschar *parse_message_id(uschar *, uschar **, uschar **);
 182 extern uschar *parse_quote_2047(uschar *, int, uschar *, uschar *, int, BOOL);
 183
 184 extern BOOL    queue_action(uschar *, int, uschar **, int, int);
 185 extern void    queue_check_only(void);
 186 extern void    queue_list(int, uschar **, int);
 187 extern void    queue_count(void);
 188 extern void    queue_run(uschar *, uschar *, BOOL);
 189
 190 extern int     random_number(int);
 191 #ifdef WITH_CONTENT_SCAN
 192 extern int     recv_line(int, uschar *, int);
 193 #endif
 194 extern int     rda_interpret(redirect_block *, int, uschar *, uschar *,
 195                  uschar *, uschar *, ugid_block *, address_item **, uschar **,
 196                  error_block **, int *, uschar *);
 197 extern int     rda_is_filter(const uschar *);
 198 extern BOOL    readconf_depends(driver_instance *, uschar *);
 199 extern void    readconf_driver_init(uschar *, driver_instance **,
 200                  driver_info *, int, void *, int, optionlist *, int);
 201 extern uschar *readconf_find_option(void *);
 202 extern void    readconf_main(void);
 203 extern void    readconf_print(uschar *, uschar *);
 204 extern uschar *readconf_printtime(int);
 205 extern uschar *readconf_readname(uschar *, int, uschar *);
 206 extern int     readconf_readtime(uschar *, int, BOOL);
 207 extern void    readconf_rest(BOOL);
 208 extern uschar *readconf_retry_error(uschar *, uschar *, int *, int *);
 209 extern void    read_message_body(BOOL);
 210 extern void    receive_bomb_out(uschar *);
 211 extern BOOL    receive_check_fs(int);
 212 extern BOOL    receive_check_set_sender(uschar *);
 213 extern BOOL    receive_msg(BOOL);
 214 extern int     receive_statvfs(BOOL, int *);
 215 extern void    receive_swallow_smtp(void);
 216 #ifdef WITH_CONTENT_SCAN
 217 extern int     regex(uschar **);
 218 #endif
 219 extern BOOL    regex_match_and_setup(const pcre *, uschar *, int, int);
 220 extern const pcre *regex_must_compile(uschar *, BOOL, BOOL);
 221 extern void    retry_add_item(address_item *, uschar *, int);
 222 extern BOOL    retry_check_address(uschar *, host_item *, uschar *, BOOL,
 223                  uschar **, uschar **);
 224 extern retry_config *retry_find_config(uschar *, uschar *, int, int);
 225 extern void    retry_update(address_item **, address_item **, address_item **);
 226 extern uschar *rewrite_address(uschar *, BOOL, BOOL, rewrite_rule *, int);
 227 extern uschar *rewrite_address_qualify(uschar *, BOOL);
 228 extern header_line *rewrite_header(header_line *, uschar *, uschar *,
 229                rewrite_rule *, int, BOOL);
 230 extern uschar *rewrite_one(uschar *, int, BOOL *, BOOL, uschar *,
 231                  rewrite_rule *);
 232 extern void    rewrite_test(uschar *);
 233 extern uschar *rfc2047_decode2(uschar *, BOOL, uschar *, int, int *, int *,
 234                  uschar **);
 235 extern int     route_address(address_item *, address_item **, address_item **,
 236                  address_item **, address_item **, int);
 237 extern int     route_check_prefix(uschar *, uschar *);
 238 extern int     route_check_suffix(uschar *, uschar *);
 239 extern BOOL    route_findgroup(uschar *, gid_t *);
 240 extern BOOL    route_finduser(uschar *, struct passwd **, uid_t *);
 241 extern BOOL    route_find_expanded_group(uschar *, uschar *, uschar *, gid_t *,
 242                  uschar **);
 243 extern BOOL    route_find_expanded_user(uschar *, uschar *, uschar *,
 244                  struct passwd **, uid_t *, uschar **);
 245 extern void    route_init(void);
 246 extern void    route_tidyup(void);
 247
 248 extern uschar *search_find(void *, uschar *, uschar *, int, uschar *, int,
 249                  int, int *);
 250 extern int     search_findtype(uschar *, int);
 251 extern int     search_findtype_partial(uschar *, int *, uschar **, int *,
 252                  int *);
 253 extern void   *search_open(uschar *, int, int, uid_t *, gid_t *);
 254 extern void    search_tidyup(void);
 255 extern void    set_process_info(char *, ...);
 256 extern void    sha1_end(sha1 *, const uschar *, int, uschar *);
 257 extern void    sha1_mid(sha1 *, const uschar *);
 258 extern void    sha1_start(sha1 *);
 259 extern int     sieve_interpret(uschar *, int, uschar *, uschar *, uschar *,
 260                  address_item **, uschar **);
 261 extern void    sigalrm_handler(int);
 262 extern void    smtp_closedown(uschar *);
 263 extern int     smtp_connect(host_item *, int, int, uschar *, int, BOOL);
 264 extern int     smtp_feof(void);
 265 extern int     smtp_ferror(void);
 266 extern uschar *smtp_get_connection_info(void);
 267 extern BOOL    smtp_get_interface(uschar *, int, address_item *, BOOL *,
 268                  uschar **, uschar *);
 269 extern BOOL    smtp_get_port(uschar *, address_item *, int *, uschar *);
 270 extern int     smtp_getc(void);
 271 extern int     smtp_handle_acl_fail(int, int, uschar *, uschar *);
 272 extern BOOL    smtp_read_response(smtp_inblock *, uschar *, int, int, int);
 273 extern void    smtp_respond(uschar *, int, BOOL, uschar *);
 274 extern void    smtp_send_prohibition_message(int, uschar *);
 275 extern int     smtp_setup_msg(void);
 276 extern BOOL    smtp_start_session(void);
 277 extern int     smtp_ungetc(int);
 278 extern BOOL    smtp_verify_helo(void);
 279 extern int     smtp_write_command(smtp_outblock *, BOOL, char *, ...);
 280 #ifdef WITH_CONTENT_SCAN
 281 extern int     spam(uschar **);
 282 extern FILE   *spool_mbox(unsigned long *);
 283 #endif
 284 extern BOOL    spool_move_message(uschar *, uschar *, uschar *, uschar *);
 285 extern BOOL    spool_open_datafile(uschar *);
 286 extern int     spool_open_temp(uschar *);
 287 extern int     spool_read_header(uschar *, BOOL, BOOL);
 288 extern int     spool_write_header(uschar *, int, uschar **);
 289 extern int     stdin_getc(void);
 290 extern int     stdin_feof(void);
 291 extern int     stdin_ferror(void);
 292 extern int     stdin_ungetc(int);
 293 extern uschar *string_append(uschar *, int *, int *, int, ...);
 294 extern uschar *string_base62(unsigned long int);
 295 extern uschar *string_cat(uschar *, int *, int *, const uschar *, int);
 296 extern uschar *string_copy_dnsdomain(uschar *);
 297 extern uschar *string_copy_malloc(uschar *);
 298 extern uschar *string_copylc(uschar *);
 299 extern uschar *string_copynlc(uschar *, int);
 300 extern uschar *string_dequote(uschar **);
 301 extern BOOL    string_format(uschar *, int, char *, ...);
 302 extern uschar *string_format_size(int, uschar *);
 303 extern int     string_interpret_escape(uschar **);
 304 extern int     string_is_ip_address(uschar *, int *);
 305 extern uschar *string_log_address(address_item *, BOOL, BOOL);
 306 extern uschar *string_nextinlist(uschar **, int *, uschar *, int);
 307 extern uschar *string_open_failed(int, char *, ...);
 308 extern uschar *string_printing2(uschar *, BOOL);
 309 extern BOOL    string_vformat(uschar *, int, char *, va_list);
 310 extern int     strcmpic(uschar *, uschar *);
 311 extern int     strncmpic(uschar *, uschar *, int);
 312 extern uschar *strstric(uschar *, uschar *, BOOL);
 313
 314 extern uschar *tod_stamp(int);
 315 extern BOOL    transport_check_waiting(uschar *, uschar *, int, uschar *,
 316                  BOOL *);
 317 extern void    transport_init(void);
 318 extern BOOL    transport_pass_socket(uschar *, uschar *, uschar *, uschar *,
 319                  int);
 320 extern uschar *transport_rcpt_address(address_item *, BOOL);
 321 extern BOOL    transport_set_up_command(uschar ***, uschar *, BOOL, int,
 322                  address_item *, uschar *, uschar **);
 323 extern void    transport_update_waiting(host_item *, uschar *);
 324 extern BOOL    transport_write_block(int, uschar *, int);
 325 extern BOOL    transport_write_string(int, char *, ...);
 326 extern BOOL    transport_write_message(address_item *, int, int, int, uschar *,
 327                  uschar *, uschar *, uschar *, rewrite_rule *, int);
 328 extern void    tree_add_duplicate(uschar *, address_item *);
 329 extern void    tree_add_nonrecipient(uschar *);
 330 extern void    tree_add_unusable(host_item *);
 331 extern int     tree_insertnode(tree_node **, tree_node *);
 332 extern tree_node *tree_search(tree_node *, uschar *);
 333 extern void    tree_write(tree_node *, FILE *);
 334 extern void    tree_walk(tree_node *, void (*)(uschar*, uschar*, void*), void *);
 335
 336 #ifdef WITH_CONTENT_SCAN
 337 extern void    unspool_mbox(void);
 338 #endif
 339
 340 extern int     verify_address(address_item *, FILE *, int, int, int, int,
 341                  uschar *, uschar *, BOOL *);
 342 extern int     verify_check_dnsbl(uschar **);
 343 extern int     verify_check_header_address(uschar **, uschar **, int, int, int,
 344                  uschar *, uschar *, int, int *);
 345 extern int     verify_check_headers(uschar **);
 346 extern int     verify_check_host(uschar **);
 347 extern int     verify_check_notblind(void);
 348 extern int     verify_check_this_host(uschar **, unsigned int *, uschar*,
 349                  uschar *, uschar **);
 350 extern address_item *verify_checked_sender(uschar *);
 351 extern void    verify_get_ident(int);
 352 extern BOOL    verify_sender(int *, uschar **);
 353 extern BOOL    verify_sender_preliminary(int *, uschar **);
 354 extern void    version_init(void);
 355
 356 /* End of functions.h */