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