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