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

Annotation of /imapfilter/imapfilter.h

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.37.2.5 - (hide annotations)
Sat Nov 9 14:20:21 2002 UTC (21 years, 4 months ago) by lefcha
Branch: release-0_8-patches
Changes since 1.37.2.4: +5 -1 lines
File MIME type: text/plain
Added option to display program's version.

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     #define IMAPFILTER_VERSION "0.8.4"
16    
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.32 #define FLAG_TTY_MODIFIED 0x01
50     #define FLAG_BLANK_PASSWORD 0x02
51 lefcha 1.25
52     /* Capabilities of mail server. */
53     #define CAPABILITY_NONE 0x00
54     #define CAPABILITY_NAMESPACE 0x01
55 lefcha 1.9
56 lefcha 1.12 /* 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 lefcha 1.17 /* Buffer size of the IMAP command. */
66 lefcha 1.9 #define SMALL_CMD 64
67 lefcha 1.32 #define MEDIUM_CMD 512
68     #define BIG_CMD 32768
69 lefcha 1.9
70 lefcha 1.35 /* 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 lefcha 1.9 /* Buffer size of server's response. */
76 lefcha 1.21 #define RESPONSE_BUF (4096 + 1)
77 lefcha 1.20 #define RESULT_BUF 512
78 lefcha 1.9
79 lefcha 1.16 /* Response codes. */
80 lefcha 1.32 #define RESPONSE_NONE -2
81 lefcha 1.16 #define RESPONSE_BAD -1
82     #define RESPONSE_OK 0
83     #define RESPONSE_NO 1
84     #define RESPONSE_BYE 2
85 lefcha 1.20 #define RESPONSE_PREAUTH 3
86     #define RESPONSE_READONLY 4
87     #define RESPONSE_TRYCREATE 5
88 lefcha 1.16
89 lefcha 1.37.2.1 /* Size virtual buffer. */
90     #define VIRTUAL_BUF 4096
91 lefcha 1.9
92 lefcha 1.25 /* Length of mailbox namespace prefix. */
93     #define NAMESPACE_PREFIX_LEN 64
94    
95 lefcha 1.26 /* Encryption and decryption buffers. */
96     #define ENCRYPTION_BUF 1024
97     #define DECRYPTION_BUF 4096
98    
99 lefcha 1.35 /* Buffer to save flags of the store IMAP command. */
100     #define STORE_FLAGS_BUF 64
101    
102 lefcha 1.27 /* Maximum passwords the password editor can handle. */
103 lefcha 1.32 #define EDITOR_PASSWORDS_MAX 64
104 lefcha 1.27
105 lefcha 1.1
106     #define min(A, B) ((A) < (B) ? (A) : (B))
107 lefcha 1.15 #define plural(A) ((A) == 1 ? "" : "s")
108 lefcha 1.1
109    
110 lefcha 1.27 /* 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 lefcha 1.32 /* Namespace of IMAP mailboxes. */
119     typedef struct namesp {
120     char prefix[NAMESPACE_PREFIX_LEN];
121     char delim;
122     } namesp_t;
123    
124    
125 lefcha 1.9 /* file.c */
126 lefcha 1.27 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 lefcha 1.25 int create_homedir(void);
135 lefcha 1.26 int exists_file(char *fname);
136     int exists_dir(char *fname);
137 lefcha 1.25 int create_file(char *fname, mode_t mode);
138 lefcha 1.9 #ifdef CHECK_PERMISSIONS
139 lefcha 1.25 int check_file_perms(char *fname, mode_t mode);
140     int check_dir_perms(char *dname, mode_t mode);
141 lefcha 1.9 #endif
142 lefcha 1.1
143 lefcha 1.9 /* imapfilter.c */
144     void usage(void);
145 lefcha 1.37.2.5 void version(void);
146 lefcha 1.1
147 lefcha 1.9 /* imap.c */
148 lefcha 1.32 unsigned int send_command(int *sock, char *cmd);
149 lefcha 1.9 #ifdef DEBUG
150 lefcha 1.32 int imap_noop(int *sock);
151 lefcha 1.9 #endif
152 lefcha 1.32 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 lefcha 1.35 int imap_store(int *sock, char *mesg, unsigned int mode, char *flags);
165 lefcha 1.32 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 lefcha 1.34 int imap_expunge(int *sock);
169 lefcha 1.29
170     /* lock.c */
171     void lockfile_create(void);
172     void lockfile_check(void);
173 lefcha 1.30 pid_t lockfile_pid(void);
174 lefcha 1.29 int lockfile_remove(void);
175 lefcha 1.30 void kill_imapfilter(void);
176 lefcha 1.9
177     /* log.c */
178 lefcha 1.13 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 lefcha 1.22 void catch_signals(void);
183     void signal_handler(int sig);
184 lefcha 1.9 int open_logfile(void);
185     int create_logfile(void);
186     int close_logfile(void);
187 lefcha 1.12 void log_info(int flag, void *ptr);
188 lefcha 1.11 char *get_time(void);
189 lefcha 1.9
190 lefcha 1.13 /* memory.c */
191     void *xmalloc(size_t size);
192 lefcha 1.19 void *xrealloc(void *ptr, size_t size);
193 lefcha 1.26 void xfree(void *ptr);
194 lefcha 1.13 char *xstrdup(const char *s);
195    
196 lefcha 1.27 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 lefcha 1.34 void secmem_append(secmem_t * node);
201 lefcha 1.27 secmem_t *secmem_find(void *ptr);
202 lefcha 1.34 void secmem_remove(secmem_t * node);
203 lefcha 1.27 void secmem_clear(void);
204 lefcha 1.37.2.3 #ifdef MEMORY_LOCK
205 lefcha 1.30 void secmem_lock(void);
206 lefcha 1.37.2.3 #endif
207 lefcha 1.27 void corefile_disable(void);
208    
209 lefcha 1.16 /* misc.c */
210     char *strcasestr(const char *haystack, const char *needle);
211     char *ultostr(unsigned long int num, int base);
212 lefcha 1.24 char *xstrncpy(char *dest, const char *src, size_t size);
213 lefcha 1.16
214 lefcha 1.25 /* passwd.c */
215 lefcha 1.26 void get_password(char *passwd, size_t pwlen);
216     #ifdef ENCRYPTED_PASSWORDS
217 lefcha 1.34 int encrypt_passwords(FILE * fd, account_t * accts[]);
218     int decrypt_passwords(unsigned char **buf, FILE * fd);
219 lefcha 1.26 void password_editor(void);
220     #endif
221 lefcha 1.25
222 lefcha 1.9 /* request.c */
223 lefcha 1.32 int test(int *sock);
224     int check_capabilities(int *sock);
225 lefcha 1.34 int check_namespace(int *sock, namesp_t * nsp);
226 lefcha 1.32 int login(int *sock, char *user, char *pass);
227 lefcha 1.34 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 lefcha 1.32 int close_mailbox(int *sock);
231     int logout(int *sock);
232 lefcha 1.9
233 lefcha 1.16 int apply_filters(filter_t ** filters);
234 lefcha 1.19 int match_filter(filter_t * filter, char **mesgs);
235 lefcha 1.9
236     void empty_fifo(mask_t ** mfifo);
237 lefcha 1.11 void queue_fifo(mask_t ** mfifo, mask_t * mask);
238     mask_t *dequeue_fifo(mask_t ** mfifo);
239 lefcha 1.9
240 lefcha 1.32 char *generate_filter_and(mask_t * mask, unsigned int masknum,
241 lefcha 1.34 unsigned int masklen);
242     char *generate_filter_or(mask_t * mask, unsigned int masknum,
243 lefcha 1.32 unsigned int masklen);
244 lefcha 1.9
245 lefcha 1.34 int apply_action(char *mesgs, unsigned int *type, account_t * raccount,
246 lefcha 1.35 char *destmbox, unsigned int *msgflags, char *args);
247 lefcha 1.9 int action_delete(char *mesgs, char *args);
248 lefcha 1.11 int action_copy(char *mesgs, char *destmbox, char *args);
249     int action_move(char *mesgs, char *destmbox, char *args);
250 lefcha 1.34 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 lefcha 1.35 int action_flag(char *mesgs, unsigned int *type, unsigned int *msgflags, char *args);
253 lefcha 1.11 int action_list(char *mesgs, char *args);
254 lefcha 1.9
255 lefcha 1.32 unsigned int count_messages(char *mesgs);
256 lefcha 1.33 char *convert_messages(char *mesgs);
257 lefcha 1.32
258 lefcha 1.9
259 lefcha 1.11 /* response.c */
260 lefcha 1.32 void receive_response(int *sock, char *buf);
261     int server_response(int *sock, unsigned int tag);
262 lefcha 1.37.2.2 void bye_response(char *buf);
263 lefcha 1.32 int greeting_response(int *sock);
264 lefcha 1.37.2.1 int logout_response(int *sock, unsigned int tag);
265 lefcha 1.32 int capability_response(int *sock, unsigned int tag);
266 lefcha 1.34 int namespace_response(int *sock, unsigned int tag, namesp_t * nsp);
267 lefcha 1.32 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 lefcha 1.37.2.5 int fetch_response(int *sock, unsigned int tag, int reset, char *fetch);
271 lefcha 1.32 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 lefcha 1.20 int analyze_response(char *buf);
275 lefcha 1.32 void init_vbuf(void);
276     void reset_vbuf(void);
277     void check_vbuf(size_t n);
278 lefcha 1.25
279     /* socket.c */
280 lefcha 1.32 int init_connection(int *sock, char *serv, unsigned short int port,
281 lefcha 1.34 unsigned int protocol);
282 lefcha 1.32 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 lefcha 1.25
287     /* tty.c */
288     int tty_store(void);
289     int tty_disable_echo(void);
290     int tty_restore(void);
291 lefcha 1.11
292 lefcha 1.13 #endif /* IMAPFILTER_H */

webmaster@linux.gr
ViewVC Help
Powered by ViewVC 1.1.26