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