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