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

Contents of /imapfilter/imapfilter.h

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.37 - (show annotations)
Fri Jul 26 18:18:42 2002 UTC (21 years, 8 months ago) by lefcha
Branch: MAIN
CVS Tags: release-0_8
Branch point for: release-0_8-patches
Changes since 1.36: +3 -2 lines
File MIME type: text/plain
New variable about mlock() warning.

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

webmaster@linux.gr
ViewVC Help
Powered by ViewVC 1.1.26