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

Contents of /imapfilter/imapfilter.h

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.43 - (show annotations)
Sat Nov 9 14:22:15 2002 UTC (21 years, 4 months ago) by lefcha
Branch: MAIN
Changes since 1.42: +5 -1 lines
File MIME type: text/plain
Added option to display program's version.

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

webmaster@linux.gr
ViewVC Help
Powered by ViewVC 1.1.26