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