More wishes.
[exim.git] / src / src / functions.h
CommitLineData
f05da2e8 1/* $Cambridge: exim/src/src/functions.h,v 1.6 2004/11/25 13:54:31 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 **);
33397d19 77extern int dns_special_lookup(dns_answer *, uschar *, int, uschar **);
059ec3d9
PH
78extern dns_record *dns_next_rr(dns_answer *, dns_scan *, int);
79extern uschar *dns_text_type(int);
80
81extern void enq_end(uschar *);
82extern BOOL enq_start(uschar *);
83extern void exim_exit(int);
84extern void exim_nullstd(void);
85extern void exim_setugid(uid_t, gid_t, BOOL, uschar *);
86extern int exim_tvcmp(struct timeval *, struct timeval *);
87extern void exim_wait_tick(struct timeval *, int);
88extern BOOL expand_check_condition(uschar *, uschar *, uschar *);
89extern uschar *expand_string(uschar *);
90extern uschar *expand_string_copy(uschar *);
91extern int expand_string_integer(uschar *);
92
93extern int filter_interpret(uschar *, int, address_item **, uschar **);
94extern BOOL filter_personal(string_item *, BOOL);
f05da2e8 95extern BOOL filter_runtest(int, uschar *, BOOL, BOOL);
059ec3d9
PH
96extern BOOL filter_system_interpret(address_item **, uschar **);
97
98extern void header_add(int, char *, ...);
99extern int header_checkname(header_line *, BOOL);
100extern BOOL header_match(uschar *, BOOL, BOOL, string_item *, int, ...);
101extern uschar *host_and_ident(BOOL);
102extern int host_aton(uschar *, int *);
103extern void host_build_hostlist(host_item **, uschar *, BOOL);
104extern ip_address_item *host_build_ifacelist(uschar *, uschar *);
105extern void host_build_log_info(void);
106extern void host_build_sender_fullhost(void);
107extern int host_extract_port(uschar *);
108extern BOOL host_find_byname(host_item *, uschar *, uschar **, BOOL);
109extern int host_find_bydns(host_item *, uschar *, int, uschar *, uschar *,
110 uschar *,uschar **, BOOL *);
111extern ip_address_item *host_find_interfaces(void);
112extern BOOL host_is_in_net(uschar *, uschar *, int);
113extern BOOL host_is_tls_on_connect_port(int);
114extern void host_mask(int, int *, int);
115extern int host_name_lookup(void);
6f0c9a4f 116extern int host_nmtoa(int, int *, int, uschar *, int);
059ec3d9
PH
117extern uschar *host_ntoa(int, const void *, uschar *, int *);
118extern int host_scan_for_local_hosts(host_item *, host_item **, BOOL *);
119
120extern int ip_bind(int, int, uschar *, int);
121extern int ip_connect(int, int, uschar *, int, int);
122extern void ip_keepalive(int, uschar *, BOOL);
123extern int ip_recv(int, uschar *, int, int);
124extern int ip_socket(int, int);
125
126extern uschar *local_part_quote(uschar *lpart);
127extern void log_close_all(void);
128
129extern int match_address_list(uschar *, BOOL, BOOL, uschar **,
130 unsigned int *, int, int, uschar **);
131extern int match_check_list(uschar **, int, tree_node **, unsigned int **,
132 int(*)(void *, uschar *, uschar **, uschar **), void *, int,
133 uschar *, uschar **);
134extern int match_isinlist(uschar *, uschar **, int, tree_node **,
135 unsigned int *, int, BOOL, uschar **);
136extern int match_check_string(uschar *, uschar *, int, BOOL, BOOL, BOOL,
137 uschar **);
138extern void md5_end(md5 *, const uschar *, int, uschar *);
139extern void md5_mid(md5 *, const uschar *);
140extern void md5_start(md5 *);
141extern void millisleep(int);
142extern uschar *moan_check_errorcopy(uschar *);
143extern BOOL moan_skipped_syntax_errors(uschar *, error_block *, uschar *,
144 BOOL, uschar *);
145extern void moan_smtp_batch(uschar *, char *, ...);
146extern void moan_tell_someone(uschar *, address_item *, uschar *, char *,
147 ...);
148extern BOOL moan_to_sender(int, error_block *, header_line *, FILE *, BOOL);
149
150extern uschar *parse_extract_address(uschar *, uschar **, int *, int *, int *,
151 BOOL);
152extern int parse_forward_list(uschar *, int, address_item **, uschar **,
153 uschar *, uschar *, error_block **);
154extern uschar *parse_find_address_end(uschar *, BOOL);
155extern uschar *parse_find_at(uschar *);
156extern uschar *parse_fix_phrase(uschar *, int, uschar *, int);
157extern uschar *parse_quote_2047(uschar *, int, uschar *, uschar *, int);
158
159extern BOOL queue_action(uschar *, int, uschar **, int, int);
160extern void queue_check_only(void);
161extern void queue_list(int, uschar **, int);
162extern void queue_count(void);
163extern void queue_run(uschar *, uschar *, BOOL);
164
165extern int random_number(int);
166extern int rda_interpret(redirect_block *, int, uschar *, uschar *, ugid_block *,
167 address_item **, uschar **, error_block **, int *, uschar *);
168extern int rda_is_filter(const uschar *);
169extern BOOL readconf_depends(driver_instance *, uschar *);
170extern void readconf_driver_init(uschar *, driver_instance **,
171 driver_info *, int, void *, int, optionlist *, int);
172extern uschar *readconf_find_option(void *);
173extern void readconf_main(void);
174extern void readconf_print(uschar *, uschar *);
175extern uschar *readconf_printtime(int);
176extern uschar *readconf_readname(uschar *, int, uschar *);
177extern int readconf_readtime(uschar *, int, BOOL);
178extern void readconf_rest(BOOL);
179extern uschar *readconf_retry_error(uschar *, uschar *, int *, int *);
180extern void receive_bomb_out(uschar *);
181extern BOOL receive_check_fs(int);
182extern BOOL receive_check_set_sender(uschar *);
183extern BOOL receive_msg(BOOL);
5cb8cbc6 184extern int receive_statvfs(BOOL, int *);
059ec3d9
PH
185extern void receive_swallow_smtp(void);
186extern BOOL regex_match_and_setup(const pcre *, uschar *, int, int);
187extern const pcre *regex_must_compile(uschar *, BOOL, BOOL);
188extern void retry_add_item(address_item *, uschar *, int);
189extern BOOL retry_check_address(uschar *, host_item *, uschar *, BOOL,
190 uschar **, uschar **);
191extern retry_config *retry_find_config(uschar *, uschar *, int, int);
192extern void retry_update(address_item **, address_item **, address_item **);
193extern uschar *rewrite_address(uschar *, BOOL, BOOL, rewrite_rule *, int);
194extern uschar *rewrite_address_qualify(uschar *, BOOL);
195extern header_line *rewrite_header(header_line *, uschar *, uschar *,
196 rewrite_rule *, int, BOOL);
197extern uschar *rewrite_one(uschar *, int, BOOL *, BOOL, uschar *,
198 rewrite_rule *);
199extern void rewrite_test(uschar *);
200extern uschar *rfc2047_decode2(uschar *, BOOL, uschar *, int, int *, int *,
201 uschar **);
202extern int route_address(address_item *, address_item **, address_item **,
203 address_item **, address_item **, int);
204extern int route_check_prefix(uschar *, uschar *);
205extern int route_check_suffix(uschar *, uschar *);
206extern BOOL route_findgroup(uschar *, gid_t *);
207extern BOOL route_finduser(uschar *, struct passwd **, uid_t *);
208extern BOOL route_find_expanded_group(uschar *, uschar *, uschar *, gid_t *,
209 uschar **);
210extern BOOL route_find_expanded_user(uschar *, uschar *, uschar *,
211 struct passwd **, uid_t *, uschar **);
212extern void route_init(void);
213extern void route_tidyup(void);
214
215extern uschar *search_find(void *, uschar *, uschar *, int, uschar *, int,
216 int, int *);
217extern int search_findtype(uschar *, int);
218extern int search_findtype_partial(uschar *, int *, uschar **, int *,
219 int *);
220extern void *search_open(uschar *, int, int, uid_t *, gid_t *);
221extern void search_tidyup(void);
222extern void set_process_info(char *, ...);
223extern void sha1_end(sha1 *, const uschar *, int, uschar *);
224extern void sha1_mid(sha1 *, const uschar *);
225extern void sha1_start(sha1 *);
226extern int sieve_interpret(uschar *, int, uschar *, address_item **,
227 uschar **);
228extern void sigalrm_handler(int);
229extern void smtp_closedown(uschar *);
230extern int smtp_connect(host_item *, int, int, uschar *, int, BOOL);
231extern int smtp_feof(void);
232extern int smtp_ferror(void);
233extern uschar *smtp_get_connection_info(void);
234extern BOOL smtp_get_interface(uschar *, int, address_item *, BOOL *,
235 uschar **, uschar *);
236extern BOOL smtp_get_port(uschar *, address_item *, int *, uschar *);
237extern int smtp_getc(void);
238extern int smtp_handle_acl_fail(int, int, uschar *, uschar *);
239extern BOOL smtp_read_response(smtp_inblock *, uschar *, int, int, int);
240extern void smtp_respond(int, BOOL, uschar *);
241extern void smtp_send_prohibition_message(int, uschar *);
242extern int smtp_setup_msg(void);
243extern BOOL smtp_start_session(void);
244extern int smtp_ungetc(int);
245extern int smtp_write_command(smtp_outblock *, BOOL, char *, ...);
246extern BOOL spool_move_message(uschar *, uschar *, uschar *, uschar *);
247extern BOOL spool_open_datafile(uschar *);
248extern int spool_open_temp(uschar *);
249extern int spool_read_header(uschar *, BOOL, BOOL);
250extern int spool_write_header(uschar *, int, uschar **);
251extern int stdin_getc(void);
252extern int stdin_feof(void);
253extern int stdin_ferror(void);
254extern int stdin_ungetc(int);
255extern uschar *string_append(uschar *, int *, int *, int, ...);
256extern uschar *string_base62(unsigned long int);
257extern uschar *string_cat(uschar *, int *, int *, const uschar *, int);
258extern uschar *string_copy_dnsdomain(uschar *);
259extern uschar *string_copy_malloc(uschar *);
260extern uschar *string_copylc(uschar *);
261extern uschar *string_copynlc(uschar *, int);
262extern uschar *string_dequote(uschar **);
263extern BOOL string_format(uschar *, int, char *, ...);
264extern uschar *string_format_size(int, uschar *);
265extern int string_interpret_escape(uschar **);
266extern int string_is_ip_address(uschar *, int *);
267extern uschar *string_log_address(address_item *, BOOL, BOOL);
268extern uschar *string_nextinlist(uschar **, int *, uschar *, int);
269extern uschar *string_open_failed(int, char *, ...);
270extern uschar *string_printing2(uschar *, BOOL);
271extern BOOL string_vformat(uschar *, int, char *, va_list);
272extern int strcmpic(uschar *, uschar *);
273extern int strncmpic(uschar *, uschar *, int);
274extern uschar *strstric(uschar *, uschar *, BOOL);
275
276extern uschar *tod_stamp(int);
277extern BOOL transport_check_waiting(uschar *, uschar *, int, uschar *,
278 BOOL *);
279extern void transport_init(void);
280extern BOOL transport_pass_socket(uschar *, uschar *, uschar *, uschar *,
281 int);
282extern uschar *transport_rcpt_address(address_item *, BOOL);
283extern BOOL transport_set_up_command(uschar ***, uschar *, BOOL, int,
284 address_item *, uschar *, uschar **);
285extern void transport_update_waiting(host_item *, uschar *);
286extern BOOL transport_write_block(int, uschar *, int);
287extern BOOL transport_write_string(int, char *, ...);
288extern BOOL transport_write_message(address_item *, int, int, int, uschar *,
289 uschar *, uschar *, uschar *, rewrite_rule *, int);
290extern void tree_add_duplicate(uschar *, address_item *);
291extern void tree_add_nonrecipient(uschar *);
292extern void tree_add_unusable(host_item *);
293extern int tree_insertnode(tree_node **, tree_node *);
294extern tree_node *tree_search(tree_node *, uschar *);
295extern void tree_write(tree_node *, FILE *);
296
4deaf07d
PH
297extern int verify_address(address_item *, FILE *, int, int, int, int,
298 uschar *, uschar *, BOOL *);
059ec3d9 299extern int verify_check_dnsbl(uschar **);
4deaf07d 300extern int verify_check_header_address(uschar **, uschar **, int, int, int,
059ec3d9
PH
301 uschar *, uschar *, int);
302extern int verify_check_headers(uschar **);
303extern int verify_check_host(uschar **);
304extern int verify_check_this_host(uschar **, unsigned int *, uschar*,
305 uschar *, uschar **);
306extern address_item *verify_checked_sender(uschar *);
307extern void verify_get_ident(int);
308extern BOOL verify_sender(int *, uschar **);
309extern BOOL verify_sender_preliminary(int *, uschar **);
310extern void version_init(void);
311
312/* End of functions.h */