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