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

Annotation of /imapfilter/imapfilter.h

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.47 - (hide annotations)
Mon Feb 3 20:22:01 2003 UTC (21 years, 1 month ago) by lefcha
Branch: MAIN
Changes since 1.46: +4 -1 lines
File MIME type: text/plain
Added i18n support, variable charset to declare character set to the server.

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

webmaster@linux.gr
ViewVC Help
Powered by ViewVC 1.1.26