Commit | Line | Data |
---|---|---|
6a8f9482 | 1 | /* $Cambridge: exim/src/src/functions.h,v 1.40 2008/01/17 13:03:35 tom Exp $ */ |
059ec3d9 PH |
2 | |
3 | /************************************************* | |
4 | * Exim - an Internet mail transport agent * | |
5 | *************************************************/ | |
6 | ||
184e8823 | 7 | /* Copyright (c) University of Cambridge 1995 - 2007 */ |
059ec3d9 PH |
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 *, | |
83da1223 PH |
27 | uschar *, uschar *, uschar *, uschar *, uschar *, uschar *, |
28 | uschar *, uschar *, int); | |
059ec3d9 PH |
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); | |
83da1223 | 34 | extern int tls_server_start(uschar *, uschar *, uschar *, uschar *); |
58eb016e | 35 | extern BOOL tls_smtp_buffered(void); |
059ec3d9 PH |
36 | extern int tls_ungetc(int); |
37 | extern int tls_write(const uschar *, size_t); | |
38 | #endif | |
39 | ||
40 | ||
41 | /* Everything else... */ | |
42 | ||
43 | extern acl_block *acl_read(uschar *(*)(void), uschar **); | |
44 | extern int acl_check(int, uschar *, uschar *, uschar **, uschar **); | |
38a0a95f PH |
45 | extern tree_node *acl_var_create(uschar *); |
46 | extern void acl_var_write(uschar *, uschar *, void *); | |
059ec3d9 PH |
47 | extern uschar *auth_b64encode(uschar *, int); |
48 | extern int auth_b64decode(uschar *, uschar **); | |
49 | extern int auth_call_pam(uschar *, uschar **); | |
50 | extern int auth_call_pwcheck(uschar *, uschar **); | |
51 | extern int auth_call_radius(uschar *, uschar **); | |
52 | extern int auth_call_saslauthd(uschar *, uschar *, uschar *, uschar *, | |
53 | uschar **); | |
16ff981e | 54 | extern int auth_check_serv_cond(auth_instance *); |
059ec3d9 PH |
55 | extern int auth_get_data(uschar **, uschar *, int); |
56 | extern int auth_get_no64_data(uschar **, uschar *); | |
57 | extern uschar *auth_xtextencode(uschar *, int); | |
58 | extern int auth_xtextdecode(uschar *, uschar **); | |
59 | ||
32d668a5 | 60 | extern int check_host(void *, uschar *, uschar **, uschar **); |
059ec3d9 PH |
61 | extern uschar **child_exec_exim(int, BOOL, int *, BOOL, int, ...); |
62 | extern pid_t child_open_uid(uschar **, uschar **, int, uid_t *, gid_t *, | |
63 | int *, int *, uschar *, BOOL); | |
64 | ||
65 | extern void daemon_go(void); | |
6a8f9482 TK |
66 | |
67 | #ifdef EXPERIMENTAL_DCC | |
68 | extern int dcc_process(uschar **); | |
69 | #endif | |
70 | ||
059ec3d9 PH |
71 | extern void debug_print_argv(uschar **); |
72 | extern void debug_print_ids(uschar *); | |
73 | extern void debug_print_string(uschar *); | |
74 | extern void debug_print_tree(tree_node *); | |
75 | extern void debug_vprintf(char *, va_list); | |
76 | extern address_item *deliver_make_addr(uschar *, BOOL); | |
77 | extern int deliver_message(uschar *, BOOL, BOOL); | |
78 | extern void deliver_msglog(const char *, ...); | |
79 | extern void deliver_set_expansions(address_item *); | |
80 | extern int deliver_split_address(address_item *); | |
81 | extern void deliver_succeeded(address_item *); | |
8523533c TK |
82 | #ifdef WITH_OLD_DEMIME |
83 | extern int demime(uschar **); | |
84 | #endif | |
059ec3d9 | 85 | extern BOOL directory_make(uschar *, uschar *, int, BOOL); |
fb2274d4 TK |
86 | #ifdef EXPERIMENTAL_DOMAINKEYS |
87 | extern BOOL dk_transport_write_message(address_item *, int, int, | |
88 | int, uschar *, uschar *, uschar *, uschar *, rewrite_rule *, | |
89 | int, uschar *, uschar *, uschar *, uschar *, uschar *, uschar *); | |
90 | #endif | |
f7572e5a TK |
91 | #ifdef EXPERIMENTAL_DKIM |
92 | extern BOOL dkim_transport_write_message(address_item *, int, int, | |
93 | int, uschar *, uschar *, uschar *, uschar *, rewrite_rule *, | |
94 | int, uschar *, uschar *, uschar *, uschar *, uschar *, uschar *); | |
95 | #endif | |
059ec3d9 PH |
96 | extern dns_address *dns_address_from_rr(dns_answer *, dns_record *); |
97 | extern void dns_build_reverse(uschar *, uschar *); | |
98 | extern void dns_init(BOOL, BOOL); | |
99 | extern int dns_basic_lookup(dns_answer *, uschar *, int); | |
100 | extern int dns_lookup(dns_answer *, uschar *, int, uschar **); | |
33397d19 | 101 | extern int dns_special_lookup(dns_answer *, uschar *, int, uschar **); |
059ec3d9 PH |
102 | extern dns_record *dns_next_rr(dns_answer *, dns_scan *, int); |
103 | extern uschar *dns_text_type(int); | |
104 | ||
105 | extern void enq_end(uschar *); | |
106 | extern BOOL enq_start(uschar *); | |
107 | extern void exim_exit(int); | |
108 | extern void exim_nullstd(void); | |
109 | extern void exim_setugid(uid_t, gid_t, BOOL, uschar *); | |
110 | extern int exim_tvcmp(struct timeval *, struct timeval *); | |
111 | extern void exim_wait_tick(struct timeval *, int); | |
112 | extern BOOL expand_check_condition(uschar *, uschar *, uschar *); | |
113 | extern uschar *expand_string(uschar *); | |
114 | extern uschar *expand_string_copy(uschar *); | |
d45b1de8 | 115 | extern int expand_string_integer(uschar *, BOOL); |
059ec3d9 PH |
116 | |
117 | extern int filter_interpret(uschar *, int, address_item **, uschar **); | |
118 | extern BOOL filter_personal(string_item *, BOOL); | |
f05da2e8 | 119 | extern BOOL filter_runtest(int, uschar *, BOOL, BOOL); |
059ec3d9 PH |
120 | extern BOOL filter_system_interpret(address_item **, uschar **); |
121 | ||
122 | extern void header_add(int, char *, ...); | |
123 | extern int header_checkname(header_line *, BOOL); | |
124 | extern BOOL header_match(uschar *, BOOL, BOOL, string_item *, int, ...); | |
7cd1141b | 125 | extern int host_address_extract_port(uschar *); |
059ec3d9 PH |
126 | extern uschar *host_and_ident(BOOL); |
127 | extern int host_aton(uschar *, int *); | |
128 | extern void host_build_hostlist(host_item **, uschar *, BOOL); | |
129 | extern ip_address_item *host_build_ifacelist(uschar *, uschar *); | |
130 | extern void host_build_log_info(void); | |
131 | extern void host_build_sender_fullhost(void); | |
322050c2 | 132 | extern BOOL host_find_byname(host_item *, uschar *, int, uschar **, BOOL); |
059ec3d9 PH |
133 | extern int host_find_bydns(host_item *, uschar *, int, uschar *, uschar *, |
134 | uschar *,uschar **, BOOL *); | |
135 | extern ip_address_item *host_find_interfaces(void); | |
136 | extern BOOL host_is_in_net(uschar *, uschar *, int); | |
137 | extern BOOL host_is_tls_on_connect_port(int); | |
7cd1141b | 138 | extern int host_item_get_port(host_item *); |
059ec3d9 PH |
139 | extern void host_mask(int, int *, int); |
140 | extern int host_name_lookup(void); | |
6f0c9a4f | 141 | extern int host_nmtoa(int, int *, int, uschar *, int); |
059ec3d9 PH |
142 | extern uschar *host_ntoa(int, const void *, uschar *, int *); |
143 | extern int host_scan_for_local_hosts(host_item *, host_item **, BOOL *); | |
144 | ||
145 | extern int ip_bind(int, int, uschar *, int); | |
146 | extern int ip_connect(int, int, uschar *, int, int); | |
147 | extern void ip_keepalive(int, uschar *, BOOL); | |
148 | extern int ip_recv(int, uschar *, int, int); | |
149 | extern int ip_socket(int, int); | |
150 | ||
151 | extern uschar *local_part_quote(uschar *lpart); | |
152 | extern void log_close_all(void); | |
153 | ||
8523533c TK |
154 | #ifdef WITH_CONTENT_SCAN |
155 | extern int malware(uschar **); | |
156 | #endif | |
059ec3d9 PH |
157 | extern int match_address_list(uschar *, BOOL, BOOL, uschar **, |
158 | unsigned int *, int, int, uschar **); | |
159 | extern int match_check_list(uschar **, int, tree_node **, unsigned int **, | |
160 | int(*)(void *, uschar *, uschar **, uschar **), void *, int, | |
161 | uschar *, uschar **); | |
162 | extern int match_isinlist(uschar *, uschar **, int, tree_node **, | |
163 | unsigned int *, int, BOOL, uschar **); | |
164 | extern int match_check_string(uschar *, uschar *, int, BOOL, BOOL, BOOL, | |
165 | uschar **); | |
166 | extern void md5_end(md5 *, const uschar *, int, uschar *); | |
167 | extern void md5_mid(md5 *, const uschar *); | |
168 | extern void md5_start(md5 *); | |
169 | extern void millisleep(int); | |
8523533c TK |
170 | #ifdef WITH_CONTENT_SCAN |
171 | struct mime_boundary_context; | |
54cdb463 PH |
172 | extern int mime_acl_check(uschar *acl, FILE *f, |
173 | struct mime_boundary_context *, uschar **, uschar **); | |
8523533c TK |
174 | extern int mime_decode(uschar **); |
175 | extern int mime_regex(uschar **); | |
176 | #endif | |
059ec3d9 PH |
177 | extern uschar *moan_check_errorcopy(uschar *); |
178 | extern BOOL moan_skipped_syntax_errors(uschar *, error_block *, uschar *, | |
179 | BOOL, uschar *); | |
180 | extern void moan_smtp_batch(uschar *, char *, ...); | |
181 | extern void moan_tell_someone(uschar *, address_item *, uschar *, char *, | |
182 | ...); | |
183 | extern BOOL moan_to_sender(int, error_block *, header_line *, FILE *, BOOL); | |
0e22dfd1 | 184 | extern void moan_write_from(FILE *); |
2632889e | 185 | extern FILE *modefopen(uschar *, char *, mode_t); |
059ec3d9 PH |
186 | |
187 | extern uschar *parse_extract_address(uschar *, uschar **, int *, int *, int *, | |
188 | BOOL); | |
189 | extern int parse_forward_list(uschar *, int, address_item **, uschar **, | |
190 | uschar *, uschar *, error_block **); | |
191 | extern uschar *parse_find_address_end(uschar *, BOOL); | |
192 | extern uschar *parse_find_at(uschar *); | |
193 | extern uschar *parse_fix_phrase(uschar *, int, uschar *, int); | |
30dba1e6 | 194 | extern uschar *parse_message_id(uschar *, uschar **, uschar **); |
46218253 | 195 | extern uschar *parse_quote_2047(uschar *, int, uschar *, uschar *, int, BOOL); |
059ec3d9 PH |
196 | |
197 | extern BOOL queue_action(uschar *, int, uschar **, int, int); | |
198 | extern void queue_check_only(void); | |
199 | extern void queue_list(int, uschar **, int); | |
200 | extern void queue_count(void); | |
201 | extern void queue_run(uschar *, uschar *, BOOL); | |
202 | ||
203 | extern int random_number(int); | |
8523533c TK |
204 | #ifdef WITH_CONTENT_SCAN |
205 | extern int recv_line(int, uschar *, int); | |
206 | #endif | |
e4a89c47 PH |
207 | extern int rda_interpret(redirect_block *, int, uschar *, uschar *, |
208 | uschar *, uschar *, ugid_block *, address_item **, uschar **, | |
209 | error_block **, int *, uschar *); | |
059ec3d9 PH |
210 | extern int rda_is_filter(const uschar *); |
211 | extern BOOL readconf_depends(driver_instance *, uschar *); | |
212 | extern void readconf_driver_init(uschar *, driver_instance **, | |
213 | driver_info *, int, void *, int, optionlist *, int); | |
214 | extern uschar *readconf_find_option(void *); | |
215 | extern void readconf_main(void); | |
216 | extern void readconf_print(uschar *, uschar *); | |
217 | extern uschar *readconf_printtime(int); | |
218 | extern uschar *readconf_readname(uschar *, int, uschar *); | |
219 | extern int readconf_readtime(uschar *, int, BOOL); | |
220 | extern void readconf_rest(BOOL); | |
221 | extern uschar *readconf_retry_error(uschar *, uschar *, int *, int *); | |
328895cc | 222 | extern void read_message_body(BOOL); |
8f128379 | 223 | extern void receive_bomb_out(uschar *, uschar *); |
059ec3d9 PH |
224 | extern BOOL receive_check_fs(int); |
225 | extern BOOL receive_check_set_sender(uschar *); | |
226 | extern BOOL receive_msg(BOOL); | |
8e669ac1 | 227 | extern int receive_statvfs(BOOL, int *); |
059ec3d9 | 228 | extern void receive_swallow_smtp(void); |
8523533c TK |
229 | #ifdef WITH_CONTENT_SCAN |
230 | extern int regex(uschar **); | |
231 | #endif | |
059ec3d9 PH |
232 | extern BOOL regex_match_and_setup(const pcre *, uschar *, int, int); |
233 | extern const pcre *regex_must_compile(uschar *, BOOL, BOOL); | |
234 | extern void retry_add_item(address_item *, uschar *, int); | |
235 | extern BOOL retry_check_address(uschar *, host_item *, uschar *, BOOL, | |
236 | uschar **, uschar **); | |
237 | extern retry_config *retry_find_config(uschar *, uschar *, int, int); | |
238 | extern void retry_update(address_item **, address_item **, address_item **); | |
239 | extern uschar *rewrite_address(uschar *, BOOL, BOOL, rewrite_rule *, int); | |
240 | extern uschar *rewrite_address_qualify(uschar *, BOOL); | |
241 | extern header_line *rewrite_header(header_line *, uschar *, uschar *, | |
242 | rewrite_rule *, int, BOOL); | |
243 | extern uschar *rewrite_one(uschar *, int, BOOL *, BOOL, uschar *, | |
244 | rewrite_rule *); | |
245 | extern void rewrite_test(uschar *); | |
246 | extern uschar *rfc2047_decode2(uschar *, BOOL, uschar *, int, int *, int *, | |
247 | uschar **); | |
248 | extern int route_address(address_item *, address_item **, address_item **, | |
249 | address_item **, address_item **, int); | |
250 | extern int route_check_prefix(uschar *, uschar *); | |
251 | extern int route_check_suffix(uschar *, uschar *); | |
252 | extern BOOL route_findgroup(uschar *, gid_t *); | |
253 | extern BOOL route_finduser(uschar *, struct passwd **, uid_t *); | |
254 | extern BOOL route_find_expanded_group(uschar *, uschar *, uschar *, gid_t *, | |
255 | uschar **); | |
256 | extern BOOL route_find_expanded_user(uschar *, uschar *, uschar *, | |
257 | struct passwd **, uid_t *, uschar **); | |
258 | extern void route_init(void); | |
259 | extern void route_tidyup(void); | |
260 | ||
261 | extern uschar *search_find(void *, uschar *, uschar *, int, uschar *, int, | |
262 | int, int *); | |
263 | extern int search_findtype(uschar *, int); | |
264 | extern int search_findtype_partial(uschar *, int *, uschar **, int *, | |
265 | int *); | |
266 | extern void *search_open(uschar *, int, int, uid_t *, gid_t *); | |
267 | extern void search_tidyup(void); | |
268 | extern void set_process_info(char *, ...); | |
269 | extern void sha1_end(sha1 *, const uschar *, int, uschar *); | |
270 | extern void sha1_mid(sha1 *, const uschar *); | |
271 | extern void sha1_start(sha1 *); | |
e4a89c47 PH |
272 | extern int sieve_interpret(uschar *, int, uschar *, uschar *, uschar *, |
273 | address_item **, uschar **); | |
059ec3d9 | 274 | extern void sigalrm_handler(int); |
58eb016e | 275 | extern BOOL smtp_buffered(void); |
059ec3d9 PH |
276 | extern void smtp_closedown(uschar *); |
277 | extern int smtp_connect(host_item *, int, int, uschar *, int, BOOL); | |
278 | extern int smtp_feof(void); | |
279 | extern int smtp_ferror(void); | |
280 | extern uschar *smtp_get_connection_info(void); | |
281 | extern BOOL smtp_get_interface(uschar *, int, address_item *, BOOL *, | |
282 | uschar **, uschar *); | |
283 | extern BOOL smtp_get_port(uschar *, address_item *, int *, uschar *); | |
284 | extern int smtp_getc(void); | |
285 | extern int smtp_handle_acl_fail(int, int, uschar *, uschar *); | |
b4ed4da0 | 286 | extern void smtp_log_no_mail(void); |
4e88a19f | 287 | extern void smtp_message_code(uschar **, int *, uschar **, uschar **); |
059ec3d9 | 288 | extern BOOL smtp_read_response(smtp_inblock *, uschar *, int, int, int); |
a5bd321b | 289 | extern void smtp_respond(uschar *, int, BOOL, uschar *); |
8f128379 | 290 | extern void smtp_notquit_exit(uschar *, uschar *, uschar *, ...); |
059ec3d9 PH |
291 | extern void smtp_send_prohibition_message(int, uschar *); |
292 | extern int smtp_setup_msg(void); | |
293 | extern BOOL smtp_start_session(void); | |
294 | extern int smtp_ungetc(int); | |
d7b47fd0 | 295 | extern BOOL smtp_verify_helo(void); |
059ec3d9 | 296 | extern int smtp_write_command(smtp_outblock *, BOOL, char *, ...); |
8523533c TK |
297 | #ifdef WITH_CONTENT_SCAN |
298 | extern int spam(uschar **); | |
f7b63901 | 299 | extern FILE *spool_mbox(unsigned long *); |
8523533c | 300 | #endif |
059ec3d9 PH |
301 | extern BOOL spool_move_message(uschar *, uschar *, uschar *, uschar *); |
302 | extern BOOL spool_open_datafile(uschar *); | |
303 | extern int spool_open_temp(uschar *); | |
304 | extern int spool_read_header(uschar *, BOOL, BOOL); | |
305 | extern int spool_write_header(uschar *, int, uschar **); | |
306 | extern int stdin_getc(void); | |
307 | extern int stdin_feof(void); | |
308 | extern int stdin_ferror(void); | |
309 | extern int stdin_ungetc(int); | |
310 | extern uschar *string_append(uschar *, int *, int *, int, ...); | |
311 | extern uschar *string_base62(unsigned long int); | |
312 | extern uschar *string_cat(uschar *, int *, int *, const uschar *, int); | |
313 | extern uschar *string_copy_dnsdomain(uschar *); | |
314 | extern uschar *string_copy_malloc(uschar *); | |
315 | extern uschar *string_copylc(uschar *); | |
316 | extern uschar *string_copynlc(uschar *, int); | |
317 | extern uschar *string_dequote(uschar **); | |
318 | extern BOOL string_format(uschar *, int, char *, ...); | |
319 | extern uschar *string_format_size(int, uschar *); | |
320 | extern int string_interpret_escape(uschar **); | |
321 | extern int string_is_ip_address(uschar *, int *); | |
322 | extern uschar *string_log_address(address_item *, BOOL, BOOL); | |
323 | extern uschar *string_nextinlist(uschar **, int *, uschar *, int); | |
324 | extern uschar *string_open_failed(int, char *, ...); | |
325 | extern uschar *string_printing2(uschar *, BOOL); | |
e28326d8 | 326 | extern uschar *string_split_message(uschar *); |
059ec3d9 PH |
327 | extern BOOL string_vformat(uschar *, int, char *, va_list); |
328 | extern int strcmpic(uschar *, uschar *); | |
329 | extern int strncmpic(uschar *, uschar *, int); | |
330 | extern uschar *strstric(uschar *, uschar *, BOOL); | |
331 | ||
332 | extern uschar *tod_stamp(int); | |
333 | extern BOOL transport_check_waiting(uschar *, uschar *, int, uschar *, | |
334 | BOOL *); | |
335 | extern void transport_init(void); | |
336 | extern BOOL transport_pass_socket(uschar *, uschar *, uschar *, uschar *, | |
337 | int); | |
338 | extern uschar *transport_rcpt_address(address_item *, BOOL); | |
339 | extern BOOL transport_set_up_command(uschar ***, uschar *, BOOL, int, | |
340 | address_item *, uschar *, uschar **); | |
341 | extern void transport_update_waiting(host_item *, uschar *); | |
342 | extern BOOL transport_write_block(int, uschar *, int); | |
343 | extern BOOL transport_write_string(int, char *, ...); | |
344 | extern BOOL transport_write_message(address_item *, int, int, int, uschar *, | |
345 | uschar *, uschar *, uschar *, rewrite_rule *, int); | |
346 | extern void tree_add_duplicate(uschar *, address_item *); | |
347 | extern void tree_add_nonrecipient(uschar *); | |
348 | extern void tree_add_unusable(host_item *); | |
349 | extern int tree_insertnode(tree_node **, tree_node *); | |
350 | extern tree_node *tree_search(tree_node *, uschar *); | |
351 | extern void tree_write(tree_node *, FILE *); | |
38a0a95f | 352 | extern void tree_walk(tree_node *, void (*)(uschar*, uschar*, void*), void *); |
059ec3d9 | 353 | |
8523533c TK |
354 | #ifdef WITH_CONTENT_SCAN |
355 | extern void unspool_mbox(void); | |
356 | #endif | |
357 | ||
4deaf07d PH |
358 | extern int verify_address(address_item *, FILE *, int, int, int, int, |
359 | uschar *, uschar *, BOOL *); | |
059ec3d9 | 360 | extern int verify_check_dnsbl(uschar **); |
4deaf07d | 361 | extern int verify_check_header_address(uschar **, uschar **, int, int, int, |
fe5b5d0b | 362 | uschar *, uschar *, int, int *); |
059ec3d9 PH |
363 | extern int verify_check_headers(uschar **); |
364 | extern int verify_check_host(uschar **); | |
1c41c9cc | 365 | extern int verify_check_notblind(void); |
059ec3d9 PH |
366 | extern int verify_check_this_host(uschar **, unsigned int *, uschar*, |
367 | uschar *, uschar **); | |
368 | extern address_item *verify_checked_sender(uschar *); | |
369 | extern void verify_get_ident(int); | |
370 | extern BOOL verify_sender(int *, uschar **); | |
371 | extern BOOL verify_sender_preliminary(int *, uschar **); | |
372 | extern void version_init(void); | |
373 | ||
374 | /* End of functions.h */ |