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

Contents of /imapfilter/imapfilter.h

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.35 - (show annotations)
Sat Jul 13 21:19:52 2002 UTC (21 years, 8 months ago) by lefcha
Branch: MAIN
Changes since 1.34: +11 -2 lines
File MIME type: text/plain
Added action flag.

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

webmaster@linux.gr
ViewVC Help
Powered by ViewVC 1.1.26