src/src/functions.h

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