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