/[imapfilter]/imapfilter/imapfilter.h
ViewVC logotype

Annotation of /imapfilter/imapfilter.h

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.37.2.12 - (hide annotations)
Mon May 26 08:14:37 2003 UTC (20 years, 10 months ago) by lefcha
Branch: release-0_8-patches
Changes since 1.37.2.11: +1 -1 lines
File MIME type: text/plain
Updated for 0.8.9.

1 lefcha 1.9 #ifndef IMAPFILTER_H
2     #define IMAPFILTER_H
3    
4     #include <stdio.h>
5 lefcha 1.25 #include <unistd.h>
6     #include <sys/stat.h>
7     #include <sys/types.h>
8 lefcha 1.29 #include <dirent.h>
9 lefcha 1.9
10     #ifndef DATA_H
11     #include "data.h"
12     #endif
13    
14 lefcha 1.37.2.5 /* Program's version number. */
15 lefcha 1.37.2.12 #define IMAPFILTER_VERSION "0.8.9"
16 lefcha 1.37.2.5
17 lefcha 1.11 /* Error codes returned by functions. */
18 lefcha 1.22 #define ERROR_SIGNAL 1
19     #define ERROR_TRIVIAL 2
20     #define ERROR_FILE_OPEN 3
21 lefcha 1.32 #define ERROR_LOCKFILE 4
22 lefcha 1.29 #define ERROR_CONFIG_PARSE 5
23     #define ERROR_MEMORY_ALLOCATION 6
24     #define ERROR_SETUID 7
25     #define ERROR_TERMIO 8
26     #define ERROR_NETWORK 9
27     #define ERROR_SSL 10
28     #define ERROR_PASSPHRASE 11
29     #define ERROR_ENCRYPT 12
30     #define ERROR_DECRYPT 13
31 lefcha 1.30 #define ERROR_FORK 14
32     #define ERROR_UNDEFINED 15
33 lefcha 1.9
34 lefcha 1.30 /* Flags that control the program's execution options. */
35 lefcha 1.36 #define OPTION_DETAILS_QUIET 0x0001
36     #define OPTION_DETAILS_NORMAL 0x0002
37     #define OPTION_DETAILS_VERBOSE 0x0004
38     #define OPTION_DETAILS_CLEAR 0xfff8
39 lefcha 1.37.2.1 #define OPTION_ERRORS 0x0008
40     #define OPTION_EXPUNGE 0x0010
41     #define OPTION_HEADERS 0x0020
42     #define OPTION_NAMESPACE 0x0040
43     #define OPTION_SUBSCRIBE 0x0080
44     #define OPTION_WARNING 0x0100
45     #define OPTION_PASSWORD_EDITOR 0x0200
46     #define OPTION_DAEMON_MODE 0x0400
47 lefcha 1.30
48     /* Other flags. */
49 lefcha 1.37.2.6 #define FLAG_TTY 0x01
50     #define FLAG_TTY_MODIFIED 0x02
51     #define FLAG_BLANK_PASSWORD 0x04
52 lefcha 1.25
53     /* Capabilities of mail server. */
54     #define CAPABILITY_NONE 0x00
55     #define CAPABILITY_NAMESPACE 0x01
56 lefcha 1.9
57 lefcha 1.12 /* Flags for logger. */
58 lefcha 1.37.2.9 #define LOG_PREAMBLE 0
59     #define LOG_ACCOUNT 1
60     #define LOG_MAILBOX 2
61     #define LOG_FILTER 3
62     #define LOG_ACTION 4
63     #define LOG_DESTINATION_ACCOUNT 5
64 lefcha 1.12 #define LOG_DESTINATION_MAILBOX 6
65 lefcha 1.37.2.9 #define LOG_HEADER 7
66 lefcha 1.12
67 lefcha 1.17 /* Buffer size of the IMAP command. */
68 lefcha 1.9 #define SMALL_CMD 64
69 lefcha 1.32 #define MEDIUM_CMD 512
70     #define BIG_CMD 32768
71 lefcha 1.9
72 lefcha 1.35 /* Store IMAP command type may replace,add or remove flags. */
73     #define STORE_FLAG_REPLACE 1
74     #define STORE_FLAG_ADD 2
75     #define STORE_FLAG_REMOVE 3
76    
77 lefcha 1.9 /* Buffer size of server's response. */
78 lefcha 1.37.2.9 #define RESPONSE_BUF 4096
79 lefcha 1.20 #define RESULT_BUF 512
80 lefcha 1.9
81 lefcha 1.16 /* Response codes. */
82 lefcha 1.37.2.6 #define RESPONSE_NULLBODY -2
83     #define RESPONSE_NONE -1
84 lefcha 1.16 #define RESPONSE_OK 0
85     #define RESPONSE_NO 1
86 lefcha 1.37.2.6 #define RESPONSE_BAD 2
87     #define RESPONSE_BYE 3
88     #define RESPONSE_PREAUTH 4
89     #define RESPONSE_READONLY 5
90     #define RESPONSE_TRYCREATE 6
91 lefcha 1.16
92 lefcha 1.37.2.1 /* Size virtual buffer. */
93     #define VIRTUAL_BUF 4096
94 lefcha 1.9
95 lefcha 1.25 /* Length of mailbox namespace prefix. */
96     #define NAMESPACE_PREFIX_LEN 64
97    
98 lefcha 1.26 /* Encryption and decryption buffers. */
99     #define ENCRYPTION_BUF 1024
100     #define DECRYPTION_BUF 4096
101    
102 lefcha 1.35 /* Buffer to save flags of the store IMAP command. */
103     #define STORE_FLAGS_BUF 64
104    
105 lefcha 1.27 /* Maximum passwords the password editor can handle. */
106 lefcha 1.32 #define EDITOR_PASSWORDS_MAX 64
107 lefcha 1.27
108 lefcha 1.1
109     #define min(A, B) ((A) < (B) ? (A) : (B))
110 lefcha 1.15 #define plural(A) ((A) == 1 ? "" : "s")
111 lefcha 1.1
112    
113 lefcha 1.27 /* Secure memory information. */
114     typedef struct secmem {
115     void *buf; /* Allocated memory buffer. */
116     size_t size; /* Size of the buffer. */
117     struct secmem *prev, *next; /* Previous/next node of doubly linked list. */
118     } secmem_t;
119    
120    
121 lefcha 1.32 /* Namespace of IMAP mailboxes. */
122     typedef struct namesp {
123     char prefix[NAMESPACE_PREFIX_LEN];
124     char delim;
125     } namesp_t;
126    
127    
128 lefcha 1.9 /* file.c */
129 lefcha 1.27 int read_config(char *cfg);
130     int parse_config(FILE * fd);
131     void set_options(char *line, regmatch_t * match);
132    
133     int read_passwords(void);
134     int parse_passwords(FILE * fd);
135     int store_passwords(account_t * accts[]);
136    
137 lefcha 1.25 int create_homedir(void);
138 lefcha 1.26 int exists_file(char *fname);
139     int exists_dir(char *fname);
140 lefcha 1.25 int create_file(char *fname, mode_t mode);
141 lefcha 1.9 #ifdef CHECK_PERMISSIONS
142 lefcha 1.25 int check_file_perms(char *fname, mode_t mode);
143     int check_dir_perms(char *dname, mode_t mode);
144 lefcha 1.9 #endif
145 lefcha 1.1
146 lefcha 1.9 /* imapfilter.c */
147     void usage(void);
148 lefcha 1.37.2.5 void version(void);
149 lefcha 1.1
150 lefcha 1.9 /* imap.c */
151 lefcha 1.32 unsigned int send_command(int *sock, char *cmd);
152 lefcha 1.9 #ifdef DEBUG
153 lefcha 1.32 int imap_noop(int *sock);
154 lefcha 1.9 #endif
155 lefcha 1.32 int imap_capability(int *sock);
156     int imap_namespace(int *sock);
157     int imap_logout(int *sock);
158     int imap_login(int *sock, char *user, char *pass);
159     /* int imap_list(int *sock, char *refer, char *mbox); */
160     int imap_subscribe(int *sock, char *mbox);
161     int imap_examine(int *sock, char *mbox);
162     int imap_select(int *sock, char *mbox);
163     int imap_status(int *sock, char *mbox, char *items);
164     int imap_create(int *sock, char *mbox);
165     int imap_search(int *sock, char *search);
166     int imap_fetch(int *sock, char *mesg, char *items);
167 lefcha 1.35 int imap_store(int *sock, char *mesg, unsigned int mode, char *flags);
168 lefcha 1.32 int imap_copy(int *sock, char *mesg, char *mbox);
169     int imap_append(int *sock, char *mbox, unsigned int size);
170     int imap_close(int *sock);
171 lefcha 1.34 int imap_expunge(int *sock);
172 lefcha 1.29
173     /* lock.c */
174     void lockfile_create(void);
175     void lockfile_check(void);
176 lefcha 1.30 pid_t lockfile_pid(void);
177 lefcha 1.29 int lockfile_remove(void);
178 lefcha 1.30 void kill_imapfilter(void);
179 lefcha 1.9
180     /* log.c */
181 lefcha 1.13 void info(const char *info,...);
182     void verbose(const char *info,...);
183     void error(const char *errmsg,...);
184     void fatal(unsigned int errnum, const char *fatal,...);
185 lefcha 1.22 void catch_signals(void);
186     void signal_handler(int sig);
187 lefcha 1.9 int open_logfile(void);
188     int create_logfile(void);
189     int close_logfile(void);
190 lefcha 1.12 void log_info(int flag, void *ptr);
191 lefcha 1.11 char *get_time(void);
192 lefcha 1.9
193 lefcha 1.13 /* memory.c */
194     void *xmalloc(size_t size);
195 lefcha 1.19 void *xrealloc(void *ptr, size_t size);
196 lefcha 1.26 void xfree(void *ptr);
197 lefcha 1.13 char *xstrdup(const char *s);
198    
199 lefcha 1.27 void *smalloc(size_t size);
200     void *srealloc(void *ptr, size_t size);
201     void sfree(void *ptr);
202     char *sstrdup(const char *s);
203 lefcha 1.34 void secmem_append(secmem_t * node);
204 lefcha 1.27 secmem_t *secmem_find(void *ptr);
205 lefcha 1.34 void secmem_remove(secmem_t * node);
206 lefcha 1.27 void secmem_clear(void);
207 lefcha 1.37.2.3 #ifdef MEMORY_LOCK
208 lefcha 1.30 void secmem_lock(void);
209 lefcha 1.37.2.3 #endif
210 lefcha 1.27 void corefile_disable(void);
211    
212 lefcha 1.16 /* misc.c */
213     char *strcasestr(const char *haystack, const char *needle);
214     char *ultostr(unsigned long int num, int base);
215 lefcha 1.24 char *xstrncpy(char *dest, const char *src, size_t size);
216 lefcha 1.16
217 lefcha 1.25 /* passwd.c */
218 lefcha 1.26 void get_password(char *passwd, size_t pwlen);
219     #ifdef ENCRYPTED_PASSWORDS
220 lefcha 1.34 int encrypt_passwords(FILE * fd, account_t * accts[]);
221     int decrypt_passwords(unsigned char **buf, FILE * fd);
222 lefcha 1.26 void password_editor(void);
223     #endif
224 lefcha 1.25
225 lefcha 1.9 /* request.c */
226 lefcha 1.32 int test(int *sock);
227     int check_capabilities(int *sock);
228 lefcha 1.34 int check_namespace(int *sock, namesp_t * nsp);
229 lefcha 1.32 int login(int *sock, char *user, char *pass);
230 lefcha 1.34 int check_mailbox(int *sock, char *mbox, namesp_t * nsp);
231     int select_mailbox(int *sock, char *mbox, namesp_t * nsp);
232     int mailbox_status(int *sock, char *mbox, namesp_t * nsp);
233 lefcha 1.32 int close_mailbox(int *sock);
234     int logout(int *sock);
235 lefcha 1.9
236 lefcha 1.16 int apply_filters(filter_t ** filters);
237 lefcha 1.19 int match_filter(filter_t * filter, char **mesgs);
238 lefcha 1.9
239     void empty_fifo(mask_t ** mfifo);
240 lefcha 1.11 void queue_fifo(mask_t ** mfifo, mask_t * mask);
241     mask_t *dequeue_fifo(mask_t ** mfifo);
242 lefcha 1.9
243 lefcha 1.32 char *generate_filter_and(mask_t * mask, unsigned int masknum,
244 lefcha 1.34 unsigned int masklen);
245     char *generate_filter_or(mask_t * mask, unsigned int masknum,
246 lefcha 1.32 unsigned int masklen);
247 lefcha 1.9
248 lefcha 1.34 int apply_action(char *mesgs, unsigned int *type, account_t * raccount,
249 lefcha 1.35 char *destmbox, unsigned int *msgflags, char *args);
250 lefcha 1.9 int action_delete(char *mesgs, char *args);
251 lefcha 1.11 int action_copy(char *mesgs, char *destmbox, char *args);
252     int action_move(char *mesgs, char *destmbox, char *args);
253 lefcha 1.34 int action_rcopy(char *mesgs, account_t * destacc, char *destmbox, char *args);
254     int action_rmove(char *mesgs, account_t * destacc, char *destmbox, char *args);
255 lefcha 1.35 int action_flag(char *mesgs, unsigned int *type, unsigned int *msgflags, char *args);
256 lefcha 1.11 int action_list(char *mesgs, char *args);
257 lefcha 1.9
258 lefcha 1.32 unsigned int count_messages(char *mesgs);
259 lefcha 1.33 char *convert_messages(char *mesgs);
260 lefcha 1.32
261 lefcha 1.9
262 lefcha 1.11 /* response.c */
263 lefcha 1.32 void receive_response(int *sock, char *buf);
264     int server_response(int *sock, unsigned int tag);
265 lefcha 1.37.2.2 void bye_response(char *buf);
266 lefcha 1.32 int greeting_response(int *sock);
267 lefcha 1.37.2.1 int logout_response(int *sock, unsigned int tag);
268 lefcha 1.32 int capability_response(int *sock, unsigned int tag);
269 lefcha 1.34 int namespace_response(int *sock, unsigned int tag, namesp_t * nsp);
270 lefcha 1.32 int status_response(int *sock, unsigned int tag, char *mbox);
271     int select_response(int *sock, unsigned int tag);
272     int search_response(int *sock, unsigned int tag, char **mesgs);
273 lefcha 1.37.2.5 int fetch_response(int *sock, unsigned int tag, int reset, char *fetch);
274 lefcha 1.32 int fetchsize_response(int *sock, unsigned int *size, unsigned int tag);
275     int append_response(int *sock, unsigned int tag);
276     int copy_response(int *sock, unsigned int tag);
277 lefcha 1.20 int analyze_response(char *buf);
278 lefcha 1.32 void init_vbuf(void);
279     void reset_vbuf(void);
280     void check_vbuf(size_t n);
281 lefcha 1.25
282     /* socket.c */
283 lefcha 1.32 int init_connection(int *sock, char *serv, unsigned short int port,
284 lefcha 1.34 unsigned int protocol);
285 lefcha 1.32 int ssl_init(int *sock, unsigned int protocol);
286     int close_connection(int *sock);
287     int socket_read(int *sock, char *buf);
288     int socket_write(int *sock, char *data);
289 lefcha 1.25
290     /* tty.c */
291     int tty_store(void);
292     int tty_disable_echo(void);
293     int tty_restore(void);
294 lefcha 1.11
295 lefcha 1.13 #endif /* IMAPFILTER_H */

webmaster@linux.gr
ViewVC Help
Powered by ViewVC 1.1.26