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