src/src/functions.h

   1 /*************************************************
   2 *     Exim - an Internet mail transport agent    *
   3 *************************************************/
   4
   5 /* Copyright (c) University of Cambridge 1995 - 2017 */
   6 /* See the file NOTICE for conditions of use and distribution. */
   7
   8
   9 /* Prototypes for functions that appear in various modules. Gathered together
  10 to avoid having a lot of tiddly little headers with only a couple of lines in
  11 them. However, some functions that are used (or not used) by utility programs
  12 are in in fact in separate headers. */
  13
  14
  15 #ifdef EXIM_PERL
  16 extern gstring *call_perl_cat(gstring *, uschar **, uschar *,
  17                  uschar **) WARN_UNUSED_RESULT;
  18 extern void    cleanup_perl(void);
  19 extern uschar *init_perl(uschar *);
  20 #endif
  21
  22
  23 #ifdef SUPPORT_TLS
  24 extern const char *
  25                std_dh_prime_default(void);
  26 extern const char *
  27                std_dh_prime_named(const uschar *);
  28
  29 extern uschar * tls_cert_crl_uri(void *, uschar * mod);
  30 extern uschar * tls_cert_ext_by_oid(void *, uschar *, int);
  31 extern uschar * tls_cert_issuer(void *, uschar * mod);
  32 extern uschar * tls_cert_not_before(void *, uschar * mod);
  33 extern uschar * tls_cert_not_after(void *, uschar * mod);
  34 extern uschar * tls_cert_ocsp_uri(void *, uschar * mod);
  35 extern uschar * tls_cert_serial_number(void *, uschar * mod);
  36 extern uschar * tls_cert_signature(void *, uschar * mod);
  37 extern uschar * tls_cert_signature_algorithm(void *, uschar * mod);
  38 extern uschar * tls_cert_subject(void *, uschar * mod);
  39 extern uschar * tls_cert_subject_altname(void *, uschar * mod);
  40 extern uschar * tls_cert_version(void *, uschar * mod);
  41
  42 extern uschar * tls_cert_der_b64(void * cert);
  43 extern uschar * tls_cert_fprt_md5(void *);
  44 extern uschar * tls_cert_fprt_sha1(void *);
  45 extern uschar * tls_cert_fprt_sha256(void *);
  46
  47 extern int     tls_client_start(int, host_item *, address_item *,
  48                  transport_instance *,
  49 # ifdef EXPERIMENTAL_DANE
  50                 dns_answer *,
  51 # endif
  52                 uschar **);
  53 extern void    tls_close(BOOL, BOOL);
  54 extern BOOL    tls_could_read(void);
  55 extern int     tls_export_cert(uschar *, size_t, void *);
  56 extern int     tls_feof(void);
  57 extern int     tls_ferror(void);
  58 extern void    tls_free_cert(void **);
  59 extern int     tls_getc(unsigned);
  60 extern uschar *tls_getbuf(unsigned *);
  61 extern void    tls_get_cache(void);
  62 extern int     tls_import_cert(const uschar *, void **);
  63 extern int     tls_read(BOOL, uschar *, size_t);
  64 extern int     tls_server_start(const uschar *, uschar **);
  65 extern BOOL    tls_smtp_buffered(void);
  66 extern int     tls_ungetc(int);
  67 extern int     tls_write(BOOL, const uschar *, size_t, BOOL);
  68 extern uschar *tls_validate_require_cipher(void);
  69 extern void    tls_version_report(FILE *);
  70 # ifndef USE_GNUTLS
  71 extern BOOL    tls_openssl_options_parse(uschar *, long *);
  72 # endif
  73 extern uschar * tls_field_from_dn(uschar *, const uschar *);
  74 extern BOOL    tls_is_name_for_cert(const uschar *, void *);
  75
  76 # ifdef EXPERIMENTAL_DANE
  77 extern int     tlsa_lookup(const host_item *, dns_answer *, BOOL);
  78 # endif
  79
  80 #endif  /*SUPPORT_TLS*/
  81
  82
  83 /* Everything else... */
  84
  85 extern acl_block *acl_read(uschar *(*)(void), uschar **);
  86 extern int     acl_check(int, uschar *, uschar *, uschar **, uschar **);
  87 extern int     acl_eval(int, uschar *, uschar **, uschar **);
  88
  89 extern tree_node *acl_var_create(uschar *);
  90 extern void    acl_var_write(uschar *, uschar *, void *);
  91 extern void    assert_no_variables(void *, int, const char *, int);
  92 extern int     auth_call_pam(const uschar *, uschar **);
  93 extern int     auth_call_pwcheck(uschar *, uschar **);
  94 extern int     auth_call_radius(const uschar *, uschar **);
  95 extern int     auth_call_saslauthd(const uschar *, const uschar *,
  96                  const uschar *, const uschar *, uschar **);
  97 extern int     auth_check_serv_cond(auth_instance *);
  98 extern int     auth_check_some_cond(auth_instance *, uschar *, uschar *, int);
  99
 100
 101 extern int     auth_get_data(uschar **, uschar *, int);
 102 extern int     auth_get_no64_data(uschar **, uschar *);
 103 extern uschar *auth_xtextencode(uschar *, int);
 104 extern int     auth_xtextdecode(uschar *, uschar **);
 105
 106 extern uschar *b64encode(uschar *, int);
 107 extern int     b64decode(const uschar *, uschar **);
 108 extern int     bdat_getc(unsigned);
 109 extern uschar *bdat_getbuf(unsigned *);
 110 extern int     bdat_ungetc(int);
 111 extern void    bdat_flush_data(void);
 112
 113 extern void    bits_clear(unsigned int *, size_t, int *);
 114 extern void    bits_set(unsigned int *, size_t, int *);
 115
 116 extern void    cancel_cutthrough_connection(BOOL, const uschar *);
 117 extern int     check_host(void *, const uschar *, const uschar **, uschar **);
 118 extern uschar **child_exec_exim(int, BOOL, int *, BOOL, int, ...);
 119 extern pid_t   child_open_uid(const uschar **, const uschar **, int,
 120                  uid_t *, gid_t *, int *, int *, uschar *, BOOL);
 121 extern BOOL    cleanup_environment(void);
 122 extern void    cutthrough_data_puts(uschar *, int);
 123 extern void    cutthrough_data_put_nl(void);
 124 extern uschar *cutthrough_finaldot(void);
 125 extern BOOL    cutthrough_flush_send(void);
 126 extern BOOL    cutthrough_headers_send(void);
 127 extern BOOL    cutthrough_predata(void);
 128 extern void    release_cutthrough_connection(const uschar *);
 129
 130 extern void    daemon_go(void);
 131
 132 #ifdef EXPERIMENTAL_DCC
 133 extern int     dcc_process(uschar **);
 134 #endif
 135
 136 extern void    debug_logging_activate(uschar *, uschar *);
 137 extern void    debug_logging_stop(void);
 138 extern void    debug_print_argv(const uschar **);
 139 extern void    debug_print_ids(uschar *);
 140 extern void    debug_printf_indent(const char *, ...) PRINTF_FUNCTION(1,2);
 141 extern void    debug_print_string(uschar *);
 142 extern void    debug_print_tree(tree_node *);
 143 extern void    debug_vprintf(int, const char *, va_list);
 144 extern void    decode_bits(unsigned int *, size_t, int *,
 145                    uschar *, bit_table *, int, uschar *, int);
 146 extern address_item *deliver_make_addr(uschar *, BOOL);
 147 extern void    deliver_init(void);
 148 extern void    delivery_log(int, address_item *, int, uschar *);
 149 extern int     deliver_message(uschar *, BOOL, BOOL);
 150 extern void    deliver_msglog(const char *, ...) PRINTF_FUNCTION(1,2);
 151 extern void    deliver_set_expansions(address_item *);
 152 extern int     deliver_split_address(address_item *);
 153 extern void    deliver_succeeded(address_item *);
 154
 155 extern uschar *deliver_get_sender_address (uschar *id);
 156 extern void    delivery_re_exec(int);
 157
 158 extern BOOL    directory_make(const uschar *, const uschar *, int, BOOL);
 159 #ifndef DISABLE_DKIM
 160 extern BOOL    dkim_transport_write_message(transport_ctx *,
 161                   struct ob_dkim *, const uschar ** errstr);
 162 #endif
 163 extern dns_address *dns_address_from_rr(dns_answer *, dns_record *);
 164 extern int     dns_basic_lookup(dns_answer *, const uschar *, int);
 165 extern void    dns_build_reverse(const uschar *, uschar *);
 166 extern void    dns_init(BOOL, BOOL, BOOL);
 167 extern BOOL    dns_is_aa(const dns_answer *);
 168 extern BOOL    dns_is_secure(const dns_answer *);
 169 extern int     dns_lookup(dns_answer *, const uschar *, int, const uschar **);
 170 extern void    dns_pattern_init(void);
 171 extern int     dns_special_lookup(dns_answer *, const uschar *, int, const uschar **);
 172 extern dns_record *dns_next_rr(const dns_answer *, dns_scan *, int);
 173 extern uschar *dns_text_type(int);
 174 extern void    dscp_list_to_stream(FILE *);
 175 extern BOOL    dscp_lookup(const uschar *, int, int *, int *, int *);
 176
 177 extern void    enq_end(uschar *);
 178 extern BOOL    enq_start(uschar *, unsigned);
 179 #ifndef DISABLE_EVENT
 180 extern uschar *event_raise(uschar *, const uschar *, uschar *);
 181 extern void    msg_event_raise(const uschar *, const address_item *);
 182 #endif
 183 extern const uschar * exim_errstr(int);
 184 extern void    exim_exit(int);
 185 extern void    exim_nullstd(void);
 186 extern void    exim_setugid(uid_t, gid_t, BOOL, uschar *);
 187 extern void    exim_wait_tick(struct timeval *, int);
 188 extern int     exp_bool(address_item *addr,
 189   uschar *mtype, uschar *mname, unsigned dgb_opt, uschar *oname, BOOL bvalue,
 190   uschar *svalue, BOOL *rvalue);
 191 extern BOOL    expand_check_condition(uschar *, uschar *, uschar *);
 192 extern uschar *expand_string(uschar *); /* public, cannot make const */
 193 extern const uschar *expand_cstring(const uschar *); /* ... so use this one */
 194 extern uschar *expand_hide_passwords(uschar * );
 195 extern uschar *expand_string_copy(const uschar *);
 196 extern int_eximarith_t expand_string_integer(uschar *, BOOL);
 197 extern void    modify_variable(uschar *, void *);
 198
 199 extern BOOL    fd_ready(int, int);
 200
 201 extern int     filter_interpret(uschar *, int, address_item **, uschar **);
 202 extern BOOL    filter_personal(string_item *, BOOL);
 203 extern BOOL    filter_runtest(int, uschar *, BOOL, BOOL);
 204 extern BOOL    filter_system_interpret(address_item **, uschar **);
 205
 206 extern uschar * fn_hdrs_added(void);
 207
 208 extern void    gstring_grow(gstring *, int, int);
 209
 210 extern void    header_add(int, const char *, ...);
 211 extern int     header_checkname(header_line *, BOOL);
 212 extern BOOL    header_match(uschar *, BOOL, BOOL, string_item *, int, ...);
 213 extern int     host_address_extract_port(uschar *);
 214 extern uschar *host_and_ident(BOOL);
 215 extern int     host_aton(const uschar *, int *);
 216 extern void    host_build_hostlist(host_item **, const uschar *, BOOL);
 217 extern ip_address_item *host_build_ifacelist(const uschar *, uschar *);
 218 extern void    host_build_log_info(void);
 219 extern void    host_build_sender_fullhost(void);
 220 extern int     host_find_byname(host_item *, const uschar *, int,
 221                                 const uschar **, BOOL);
 222 extern int     host_find_bydns(host_item *, const uschar *, int, uschar *, uschar *,
 223                  uschar *, const dnssec_domains *, const uschar **, BOOL *);
 224 extern ip_address_item *host_find_interfaces(void);
 225 extern BOOL    host_is_in_net(const uschar *, const uschar *, int);
 226 extern BOOL    host_is_tls_on_connect_port(int);
 227 extern int     host_item_get_port(host_item *);
 228 extern void    host_mask(int, int *, int);
 229 extern int     host_name_lookup(void);
 230 extern int     host_nmtoa(int, int *, int, uschar *, int);
 231 extern uschar *host_ntoa(int, const void *, uschar *, int *);
 232 extern int     host_scan_for_local_hosts(host_item *, host_item **, BOOL *);
 233
 234 extern uschar *imap_utf7_encode(uschar *, const uschar *,
 235                                  uschar, uschar *, uschar **);
 236
 237 extern void    invert_address(uschar *, uschar *);
 238 extern int     ip_addr(void *, int, const uschar *, int);
 239 extern int     ip_bind(int, int, uschar *, int);
 240 extern int     ip_connect(int, int, const uschar *, int, int, const blob *);
 241 extern int     ip_connectedsocket(int, const uschar *, int, int,
 242                  int, host_item *, uschar **, const blob *);
 243 extern int     ip_get_address_family(int);
 244 extern void    ip_keepalive(int, const uschar *, BOOL);
 245 extern int     ip_recv(int, uschar *, int, int);
 246 extern int     ip_socket(int, int);
 247
 248 extern int     ip_tcpsocket(const uschar *, uschar **, int);
 249 extern int     ip_unixsocket(const uschar *, uschar **);
 250 extern int     ip_streamsocket(const uschar *, uschar **, int);
 251
 252 extern int     ipv6_nmtoa(int *, uschar *);
 253
 254 extern uschar *local_part_quote(uschar *);
 255 extern int     log_create(uschar *);
 256 extern int     log_create_as_exim(uschar *);
 257 extern void    log_close_all(void);
 258
 259 extern macro_item * macro_create(const uschar *, const uschar *, BOOL);
 260 extern void    mainlog_close(void);
 261 #ifdef WITH_CONTENT_SCAN
 262 extern int     malware(const uschar *, int);
 263 extern int     malware_in_file(uschar *);
 264 extern void    malware_init(void);
 265 #endif
 266 extern int     match_address_list(const uschar *, BOOL, BOOL, const uschar **,
 267                  unsigned int *, int, int, const uschar **);
 268 extern int     match_address_list_basic(const uschar *, const uschar **, int);
 269 extern int     match_check_list(const uschar **, int, tree_node **, unsigned int **,
 270                  int(*)(void *, const uschar *, const uschar **, uschar **), void *, int,
 271                  const uschar *, const uschar **);
 272 extern int     match_isinlist(const uschar *, const uschar **, int, tree_node **,
 273                  unsigned int *, int, BOOL, const uschar **);
 274 extern int     match_check_string(const uschar *, const uschar *, int, BOOL, BOOL, BOOL,
 275                  const uschar **);
 276 extern void    md5_end(md5 *, const uschar *, int, uschar *);
 277 extern void    md5_mid(md5 *, const uschar *);
 278 extern void    md5_start(md5 *);
 279 extern void    millisleep(int);
 280 #ifdef WITH_CONTENT_SCAN
 281 struct mime_boundary_context;
 282 extern int     mime_acl_check(uschar *acl, FILE *f,
 283                  struct mime_boundary_context *, uschar **, uschar **);
 284 extern int     mime_decode(const uschar **);
 285 extern ssize_t mime_decode_base64(FILE *, FILE *, uschar *);
 286 extern int     mime_regex(const uschar **);
 287 extern void    mime_set_anomaly(int);
 288 #endif
 289 extern uschar *moan_check_errorcopy(uschar *);
 290 extern BOOL    moan_skipped_syntax_errors(uschar *, error_block *, uschar *,
 291                  BOOL, uschar *);
 292 extern void    moan_smtp_batch(uschar *, const char *, ...) PRINTF_FUNCTION(2,3);
 293 extern void    moan_tell_someone(uschar *, address_item *,
 294                  const uschar *, const char *, ...) PRINTF_FUNCTION(4,5);
 295 extern BOOL    moan_to_sender(int, error_block *, header_line *, FILE *, BOOL);
 296 extern void    moan_write_from(FILE *);
 297 extern FILE   *modefopen(const uschar *, const char *, mode_t);
 298
 299 extern int     open_cutthrough_connection( address_item * addr );
 300
 301 extern uschar *parse_extract_address(uschar *, uschar **, int *, int *, int *,
 302                  BOOL);
 303 extern int     parse_forward_list(uschar *, int, address_item **, uschar **,
 304                  const uschar *, uschar *, error_block **);
 305 extern uschar *parse_find_address_end(uschar *, BOOL);
 306 extern uschar *parse_find_at(uschar *);
 307 extern const uschar *parse_fix_phrase(const uschar *, int, uschar *, int);
 308 extern uschar *parse_message_id(uschar *, uschar **, uschar **);
 309 extern const uschar *parse_quote_2047(const uschar *, int, uschar *, uschar *, int, BOOL);
 310 extern uschar *parse_date_time(uschar *str, time_t *t);
 311 extern int     vaguely_random_number(int);
 312 #ifdef SUPPORT_TLS
 313 extern int     vaguely_random_number_fallback(int);
 314 #endif
 315
 316 extern BOOL    queue_action(uschar *, int, uschar **, int, int);
 317 extern void    queue_check_only(void);
 318 extern void    queue_list(int, uschar **, int);
 319 extern void    queue_count(void);
 320 extern void    queue_run(uschar *, uschar *, BOOL);
 321
 322 extern int     random_number(int);
 323 extern int     rda_interpret(redirect_block *, int, uschar *, uschar *,
 324                  uschar *, uschar *, uschar *, ugid_block *, address_item **,
 325                  uschar **, error_block **, int *, uschar *);
 326 extern int     rda_is_filter(const uschar *);
 327 extern BOOL    readconf_depends(driver_instance *, uschar *);
 328 extern void    readconf_driver_init(uschar *, driver_instance **,
 329                  driver_info *, int, void *, int, optionlist *, int);
 330 extern uschar *readconf_find_option(void *);
 331 extern void    readconf_main(BOOL);
 332 extern void    readconf_options_from_list(optionlist *, unsigned, const uschar *, uschar *);
 333 extern void    readconf_print(uschar *, uschar *, BOOL);
 334 extern uschar *readconf_printtime(int);
 335 extern uschar *readconf_readname(uschar *, int, uschar *);
 336 extern int     readconf_readtime(const uschar *, int, BOOL);
 337 extern void    readconf_rest(void);
 338 extern uschar *readconf_retry_error(const uschar *, const uschar *, int *, int *);
 339 extern void    readconf_save_config(const uschar *);
 340 extern void    read_message_body(BOOL);
 341 extern void    receive_bomb_out(uschar *, uschar *);
 342 extern BOOL    receive_check_fs(int);
 343 extern BOOL    receive_check_set_sender(uschar *);
 344 extern BOOL    receive_msg(BOOL);
 345 extern int     receive_statvfs(BOOL, int *);
 346 extern void    receive_swallow_smtp(void);
 347 #ifdef WITH_CONTENT_SCAN
 348 extern int     regex(const uschar **);
 349 #endif
 350 extern BOOL    regex_match_and_setup(const pcre *, const uschar *, int, int);
 351 extern const pcre *regex_must_compile(const uschar *, BOOL, BOOL);
 352 extern void    retry_add_item(address_item *, uschar *, int);
 353 extern BOOL    retry_check_address(const uschar *, host_item *, uschar *, BOOL,
 354                  uschar **, uschar **);
 355 extern retry_config *retry_find_config(const uschar *, const uschar *, int, int);
 356 extern BOOL    retry_ultimate_address_timeout(uschar *, const uschar *,
 357                  dbdata_retry *, time_t);
 358 extern void    retry_update(address_item **, address_item **, address_item **);
 359 extern uschar *rewrite_address(uschar *, BOOL, BOOL, rewrite_rule *, int);
 360 extern uschar *rewrite_address_qualify(uschar *, BOOL);
 361 extern header_line *rewrite_header(header_line *,
 362                const uschar *, const uschar *,
 363                rewrite_rule *, int, BOOL);
 364 extern uschar *rewrite_one(uschar *, int, BOOL *, BOOL, uschar *,
 365                  rewrite_rule *);
 366 extern void    rewrite_test(uschar *);
 367 extern uschar *rfc2047_decode2(uschar *, BOOL, uschar *, int, int *, int *,
 368                  uschar **);
 369 extern int     route_address(address_item *, address_item **, address_item **,
 370                  address_item **, address_item **, int);
 371 extern int     route_check_prefix(const uschar *, const uschar *);
 372 extern int     route_check_suffix(const uschar *, const uschar *);
 373 extern BOOL    route_findgroup(uschar *, gid_t *);
 374 extern BOOL    route_finduser(const uschar *, struct passwd **, uid_t *);
 375 extern BOOL    route_find_expanded_group(uschar *, uschar *, uschar *, gid_t *,
 376                  uschar **);
 377 extern BOOL    route_find_expanded_user(uschar *, uschar *, uschar *,
 378                  struct passwd **, uid_t *, uschar **);
 379 extern void    route_init(void);
 380 extern void    route_tidyup(void);
 381
 382 extern uschar *search_find(void *, uschar *, uschar *, int, const uschar *, int,
 383                  int, int *);
 384 extern int     search_findtype(const uschar *, int);
 385 extern int     search_findtype_partial(const uschar *, int *, const uschar **, int *,
 386                  int *);
 387 extern void   *search_open(uschar *, int, int, uid_t *, gid_t *);
 388 extern void    search_tidyup(void);
 389 extern void    set_process_info(const char *, ...) PRINTF_FUNCTION(1,2);
 390 extern void    sha1_end(hctx *, const uschar *, int, uschar *);
 391 extern void    sha1_mid(hctx *, const uschar *);
 392 extern void    sha1_start(hctx *);
 393 extern int     sieve_interpret(uschar *, int, uschar *, uschar *, uschar *,
 394                  uschar *, address_item **, uschar **);
 395 extern void    sigalrm_handler(int);
 396 extern BOOL    smtp_buffered(void);
 397 extern void    smtp_closedown(uschar *);
 398 extern uschar *smtp_cmd_hist(void);
 399 extern int     smtp_connect(host_item *, int, uschar *, int,
 400                  transport_instance *);
 401 extern int     smtp_sock_connect(host_item *, int, int, uschar *,
 402                  transport_instance * tb, int, const blob *);
 403 extern int     smtp_feof(void);
 404 extern int     smtp_ferror(void);
 405 extern uschar *smtp_get_connection_info(void);
 406 extern BOOL    smtp_get_interface(uschar *, int, address_item *,
 407                  uschar **, uschar *);
 408 extern BOOL    smtp_get_port(uschar *, address_item *, int *, uschar *);
 409 extern int     smtp_getc(unsigned);
 410 extern uschar *smtp_getbuf(unsigned *);
 411 extern void    smtp_get_cache(void);
 412 extern int     smtp_handle_acl_fail(int, int, uschar *, uschar *);
 413 extern void    smtp_log_no_mail(void);
 414 extern void    smtp_message_code(uschar **, int *, uschar **, uschar **, BOOL);
 415 extern void    smtp_proxy_tls(uschar *, size_t, int, int);
 416 extern BOOL    smtp_read_response(smtp_inblock *, uschar *, int, int, int);
 417 extern void    smtp_respond(uschar *, int, BOOL, uschar *);
 418 extern void    smtp_notquit_exit(uschar *, uschar *, uschar *, ...);
 419 extern void    smtp_port_for_connect(host_item *, int);
 420 extern void    smtp_send_prohibition_message(int, uschar *);
 421 extern int     smtp_setup_msg(void);
 422 extern BOOL    smtp_start_session(void);
 423 extern int     smtp_ungetc(int);
 424 extern BOOL    smtp_verify_helo(void);
 425 extern int     smtp_write_command(smtp_outblock *, int, const char *, ...) PRINTF_FUNCTION(3,4);
 426 #ifdef WITH_CONTENT_SCAN
 427 extern int     spam(const uschar **);
 428 extern FILE   *spool_mbox(unsigned long *, const uschar *, uschar **);
 429 #endif
 430 extern BOOL    spool_move_message(uschar *, uschar *, uschar *, uschar *);
 431 extern uschar *spool_dname(const uschar *, uschar *);
 432 extern uschar *spool_fname(const uschar *, const uschar *, const uschar *, const uschar *);
 433 extern uschar *spool_sname(const uschar *, uschar *);
 434 extern int     spool_open_datafile(uschar *);
 435 extern int     spool_open_temp(uschar *);
 436 extern int     spool_read_header(uschar *, BOOL, BOOL);
 437 extern int     spool_write_header(uschar *, int, uschar **);
 438 extern int     stdin_getc(unsigned);
 439 extern int     stdin_feof(void);
 440 extern int     stdin_ferror(void);
 441 extern int     stdin_ungetc(int);
 442 extern gstring *string_append(gstring *, int, ...) WARN_UNUSED_RESULT;
 443 extern gstring *string_append_listele(gstring *, uschar, const uschar *) WARN_UNUSED_RESULT;
 444 extern gstring *string_append_listele_n(gstring *, uschar, const uschar *, unsigned) WARN_UNUSED_RESULT;
 445 extern uschar *string_base62(unsigned long int);
 446 extern int     string_compare_by_pointer(const void *, const void *);
 447 extern uschar *string_copy_dnsdomain(uschar *);
 448 extern uschar *string_copy_malloc(const uschar *);
 449 extern uschar *string_copylc(const uschar *);
 450 extern uschar *string_copynlc(uschar *, int);
 451 extern uschar *string_dequote(const uschar **);
 452 extern BOOL    string_format(uschar *, int, const char *, ...) ALMOST_PRINTF(3,4);
 453 extern uschar *string_format_size(int, uschar *);
 454 extern int     string_interpret_escape(const uschar **);
 455 extern int     string_is_ip_address(const uschar *, int *);
 456 #ifdef SUPPORT_I18N
 457 extern BOOL    string_is_utf8(const uschar *);
 458 #endif
 459 extern uschar *string_nextinlist(const uschar **, int *, uschar *, int);
 460 extern uschar *string_open_failed(int, const char *, ...) PRINTF_FUNCTION(2,3);
 461 extern const uschar *string_printing2(const uschar *, BOOL);
 462 extern uschar *string_split_message(uschar *);
 463 extern uschar *string_timesince(struct timeval *);
 464 extern uschar *string_unprinting(uschar *);
 465 #ifdef SUPPORT_I18N
 466 extern uschar *string_address_utf8_to_alabel(const uschar *, uschar **);
 467 extern uschar *string_domain_alabel_to_utf8(const uschar *, uschar **);
 468 extern uschar *string_domain_utf8_to_alabel(const uschar *, uschar **);
 469 extern uschar *string_localpart_alabel_to_utf8(const uschar *, uschar **);
 470 extern uschar *string_localpart_utf8_to_alabel(const uschar *, uschar **);
 471 #endif
 472 extern BOOL    string_vformat(uschar *, int, const char *, va_list);
 473 extern int     strcmpic(const uschar *, const uschar *);
 474 extern int     strncmpic(const uschar *, const uschar *, int);
 475 extern uschar *strstric(uschar *, uschar *, BOOL);
 476
 477 extern void    timesince(struct timeval * diff, struct timeval * then);
 478 extern void    tls_modify_variables(tls_support *);
 479 extern uschar *tod_stamp(int);
 480
 481 extern BOOL    transport_check_waiting(const uschar *, const uschar *, int, uschar *,
 482                  BOOL *, oicf, void*);
 483 extern void    transport_init(void);
 484 extern void    transport_do_pass_socket(const uschar *, const uschar *,
 485                  const uschar *, uschar *, int);
 486 extern BOOL    transport_pass_socket(const uschar *, const uschar *, const uschar *, uschar *,
 487                  int);
 488 extern uschar *transport_rcpt_address(address_item *, BOOL);
 489 extern BOOL    transport_set_up_command(const uschar ***, uschar *,
 490                  BOOL, int, address_item *, uschar *, uschar **);
 491 extern void    transport_update_waiting(host_item *, uschar *);
 492 extern BOOL    transport_write_block(transport_ctx *, uschar *, int, BOOL);
 493 extern void    transport_write_reset(int);
 494 extern BOOL    transport_write_string(int, const char *, ...);
 495 extern BOOL    transport_headers_send(transport_ctx *,
 496                  BOOL (*)(transport_ctx *, uschar *, int));
 497 extern BOOL    transport_write_message(transport_ctx *, int);
 498 extern void    tree_add_duplicate(uschar *, address_item *);
 499 extern void    tree_add_nonrecipient(uschar *);
 500 extern void    tree_add_unusable(host_item *);
 501 extern int     tree_insertnode(tree_node **, tree_node *);
 502 extern tree_node *tree_search(tree_node *, const uschar *);
 503 extern void    tree_write(tree_node *, FILE *);
 504 extern void    tree_walk(tree_node *, void (*)(uschar*, uschar*, void*), void *);
 505
 506 #ifdef WITH_CONTENT_SCAN
 507 extern void    unspool_mbox(void);
 508 #endif
 509 #ifdef SUPPORT_I18N
 510 extern void    utf8_version_report(FILE *);
 511 #endif
 512
 513 extern int     verify_address(address_item *, FILE *, int, int, int, int,
 514                  uschar *, uschar *, BOOL *);
 515 extern int     verify_check_dnsbl(int, const uschar **, uschar **);
 516 extern int     verify_check_header_address(uschar **, uschar **, int, int, int,
 517                  uschar *, uschar *, int, int *);
 518 extern int     verify_check_headers(uschar **);
 519 extern int     verify_check_header_names_ascii(uschar **);
 520 extern int     verify_check_host(uschar **);
 521 extern int     verify_check_notblind(void);
 522 extern int     verify_check_given_host(uschar **, host_item *);
 523 extern int     verify_check_this_host(const uschar **, unsigned int *,
 524                  const uschar*, const uschar *, const uschar **);
 525 extern address_item *verify_checked_sender(uschar *);
 526 extern void    verify_get_ident(int);
 527 extern BOOL    verify_sender(int *, uschar **);
 528 extern BOOL    verify_sender_preliminary(int *, uschar **);
 529 extern void    version_init(void);
 530
 531 extern BOOL    write_chunk(transport_ctx *, uschar *, int);
 532 extern ssize_t write_to_fd_buf(int, const uschar *, size_t);
 533
 534 /******************************************************************************/
 535
 536 #if !defined(COMPILE_UTILITY) && !defined(MACRO_PREDEF)
 537
 538 /* Create a growable-string with some preassigned space */
 539
 540 __inline__ gstring *
 541 string_get(unsigned size)
 542 {
 543 gstring * g = store_get(sizeof(gstring) + size);
 544 g->size = size;
 545 g->ptr = 0;
 546 g->s = US(g + 1);
 547 return g;
 548 }
 549
 550
 551 /* NUL-terminate the C string in the growable-string, and return it. */
 552
 553 __inline__ uschar *
 554 string_from_gstring(gstring * g)
 555 {
 556 if (!g) return NULL;
 557 g->s[g->ptr] = '\0';
 558 return g->s;
 559 }
 560
 561
 562
 563 /* This function is used when building up strings of unknown length. Room is
 564 always left for a terminating zero to be added to the string that is being
 565 built. This function does not require the string that is being added to be NUL
 566 terminated, because the number of characters to add is given explicitly. It is
 567 sometimes called to extract parts of other strings.
 568
 569 Arguments:
 570   string   points to the start of the string that is being built, or NULL
 571              if this is a new string that has no contents yet
 572   s        points to characters to add
 573   count    count of characters to add; must not exceed the length of s, if s
 574              is a C string.
 575
 576 Returns:   pointer to the start of the string, changed if copied for expansion.
 577            Note that a NUL is not added, though space is left for one. This is
 578            because string_cat() is often called multiple times to build up a
 579            string - there's no point adding the NUL till the end.
 580
 581 */
 582 /* coverity[+alloc] */
 583
 584 WARN_UNUSED_RESULT
 585 __inline__ gstring *
 586 string_catn(gstring * g, const uschar *s, int count)
 587 {
 588 int p;
 589
 590 if (!g)
 591   {
 592   unsigned inc = count < 4096 ? 127 : 1023;
 593   unsigned size = ((count + inc) &  ~inc) + 1;
 594   g = string_get(size);
 595   }
 596
 597 p = g->ptr;
 598 if (p + count >= g->size)
 599   gstring_grow(g, p, count);
 600
 601 /* Because we always specify the exact number of characters to copy, we can
 602 use memcpy(), which is likely to be more efficient than strncopy() because the
 603 latter has to check for zero bytes. */
 604
 605 memcpy(g->s + p, s, count);
 606 g->ptr = p + count;
 607 return g;
 608 }
 609
 610
 611 WARN_UNUSED_RESULT
 612 __inline__ gstring *
 613 string_cat(gstring *string, const uschar *s)
 614 {
 615 return string_catn(string, s, Ustrlen(s));
 616 }
 617 #endif  /*!COMPILE_UTILITY*/
 618
 619
 620
 621 /* vi: aw
 622 */
 623 /* End of functions.h */