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

Contents of /imapfilter/imapfilter.h

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.37.2.9 - (show annotations)
Fri Mar 28 16:57:52 2003 UTC (21 years ago) by lefcha
Branch: release-0_8-patches
Changes since 1.37.2.8: +8 -7 lines
File MIME type: text/plain
Correct bug with long headers along with action list and logger.

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.6"
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 0x01
50 #define FLAG_TTY_MODIFIED 0x02
51 #define FLAG_BLANK_PASSWORD 0x04
52
53 /* Capabilities of mail server. */
54 #define CAPABILITY_NONE 0x00
55 #define CAPABILITY_NAMESPACE 0x01
56
57 /* Flags for logger. */
58 #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 #define LOG_DESTINATION_MAILBOX 6
65 #define LOG_HEADER 7
66
67 /* Buffer size of the IMAP command. */
68 #define SMALL_CMD 64
69 #define MEDIUM_CMD 512
70 #define BIG_CMD 32768
71
72 /* 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 /* Buffer size of server's response. */
78 #define RESPONSE_BUF 4096
79 #define RESULT_BUF 512
80
81 /* Response codes. */
82 #define RESPONSE_NULLBODY -2
83 #define RESPONSE_NONE -1
84 #define RESPONSE_OK 0
85 #define RESPONSE_NO 1
86 #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
92 /* Size virtual buffer. */
93 #define VIRTUAL_BUF 4096
94
95 /* Length of mailbox namespace prefix. */
96 #define NAMESPACE_PREFIX_LEN 64
97
98 /* Encryption and decryption buffers. */
99 #define ENCRYPTION_BUF 1024
100 #define DECRYPTION_BUF 4096
101
102 /* Buffer to save flags of the store IMAP command. */
103 #define STORE_FLAGS_BUF 64
104
105 /* Maximum passwords the password editor can handle. */
106 #define EDITOR_PASSWORDS_MAX 64
107
108
109 #define min(A, B) ((A) < (B) ? (A) : (B))
110 #define plural(A) ((A) == 1 ? "" : "s")
111
112
113 /* 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 /* Namespace of IMAP mailboxes. */
122 typedef struct namesp {
123 char prefix[NAMESPACE_PREFIX_LEN];
124 char delim;
125 } namesp_t;
126
127
128 /* file.c */
129 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 int create_homedir(void);
138 int exists_file(char *fname);
139 int exists_dir(char *fname);
140 int create_file(char *fname, mode_t mode);
141 #ifdef CHECK_PERMISSIONS
142 int check_file_perms(char *fname, mode_t mode);
143 int check_dir_perms(char *dname, mode_t mode);
144 #endif
145
146 /* imapfilter.c */
147 void usage(void);
148 void version(void);
149
150 /* imap.c */
151 unsigned int send_command(int *sock, char *cmd);
152 #ifdef DEBUG
153 int imap_noop(int *sock);
154 #endif
155 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 int imap_store(int *sock, char *mesg, unsigned int mode, char *flags);
168 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 int imap_expunge(int *sock);
172
173 /* lock.c */
174 void lockfile_create(void);
175 void lockfile_check(void);
176 pid_t lockfile_pid(void);
177 int lockfile_remove(void);
178 void kill_imapfilter(void);
179
180 /* log.c */
181 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 void catch_signals(void);
186 void signal_handler(int sig);
187 int open_logfile(void);
188 int create_logfile(void);
189 int close_logfile(void);
190 void log_info(int flag, void *ptr);
191 char *get_time(void);
192
193 /* memory.c */
194 void *xmalloc(size_t size);
195 void *xrealloc(void *ptr, size_t size);
196 void xfree(void *ptr);
197 char *xstrdup(const char *s);
198
199 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 void secmem_append(secmem_t * node);
204 secmem_t *secmem_find(void *ptr);
205 void secmem_remove(secmem_t * node);
206 void secmem_clear(void);
207 #ifdef MEMORY_LOCK
208 void secmem_lock(void);
209 #endif
210 void corefile_disable(void);
211
212 /* misc.c */
213 char *strcasestr(const char *haystack, const char *needle);
214 char *ultostr(unsigned long int num, int base);
215 char *xstrncpy(char *dest, const char *src, size_t size);
216
217 /* passwd.c */
218 void get_password(char *passwd, size_t pwlen);
219 #ifdef ENCRYPTED_PASSWORDS
220 int encrypt_passwords(FILE * fd, account_t * accts[]);
221 int decrypt_passwords(unsigned char **buf, FILE * fd);
222 void password_editor(void);
223 #endif
224
225 /* request.c */
226 int test(int *sock);
227 int check_capabilities(int *sock);
228 int check_namespace(int *sock, namesp_t * nsp);
229 int login(int *sock, char *user, char *pass);
230 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 int close_mailbox(int *sock);
234 int logout(int *sock);
235
236 int apply_filters(filter_t ** filters);
237 int match_filter(filter_t * filter, char **mesgs);
238
239 void empty_fifo(mask_t ** mfifo);
240 void queue_fifo(mask_t ** mfifo, mask_t * mask);
241 mask_t *dequeue_fifo(mask_t ** mfifo);
242
243 char *generate_filter_and(mask_t * mask, unsigned int masknum,
244 unsigned int masklen);
245 char *generate_filter_or(mask_t * mask, unsigned int masknum,
246 unsigned int masklen);
247
248 int apply_action(char *mesgs, unsigned int *type, account_t * raccount,
249 char *destmbox, unsigned int *msgflags, char *args);
250 int action_delete(char *mesgs, char *args);
251 int action_copy(char *mesgs, char *destmbox, char *args);
252 int action_move(char *mesgs, char *destmbox, char *args);
253 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 int action_flag(char *mesgs, unsigned int *type, unsigned int *msgflags, char *args);
256 int action_list(char *mesgs, char *args);
257
258 unsigned int count_messages(char *mesgs);
259 char *convert_messages(char *mesgs);
260
261
262 /* response.c */
263 void receive_response(int *sock, char *buf);
264 int server_response(int *sock, unsigned int tag);
265 void bye_response(char *buf);
266 int greeting_response(int *sock);
267 int logout_response(int *sock, unsigned int tag);
268 int capability_response(int *sock, unsigned int tag);
269 int namespace_response(int *sock, unsigned int tag, namesp_t * nsp);
270 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 int fetch_response(int *sock, unsigned int tag, int reset, char *fetch);
274 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 int analyze_response(char *buf);
278 void init_vbuf(void);
279 void reset_vbuf(void);
280 void check_vbuf(size_t n);
281
282 /* socket.c */
283 int init_connection(int *sock, char *serv, unsigned short int port,
284 unsigned int protocol);
285 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
290 /* tty.c */
291 int tty_store(void);
292 int tty_disable_echo(void);
293 int tty_restore(void);
294
295 #endif /* IMAPFILTER_H */

webmaster@linux.gr
ViewVC Help
Powered by ViewVC 1.1.26