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