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