imapfilter/imapfilter/imapfilter.h

#ifndef IMAPFILTER_H
#define IMAPFILTER_H

#include <stdio.h>
#include <unistd.h>
#include <sys/stat.h>
#include <sys/types.h>

#ifndef DATA_H
#include "data.h"
#endif

/* Error codes returned by functions. */
#define ERROR_SIGNAL                    1
#define ERROR_TRIVIAL                   2
#define ERROR_FILE_OPEN                 3
#define ERROR_CONFIG_PARSE              4
#define ERROR_MEMORY_ALLOCATION         5
#define ERROR_TERMIO                    6
#define ERROR_NETWORK                   7
#define ERROR_SSL                       8
#define ERROR_UNDEFINED                 9

/* Flags that control the program's options. */
#define OPTION_DETAILS_QUIET            0x01
#define OPTION_DETAILS_NORMAL           0x02
#define OPTION_DETAILS_VERBOSE          0x04
#define OPTION_DETAILS_CLEAR            0xf8
#define OPTION_HEADERS                  0x08
#define OPTION_NAMESPACE                0x10

/* Capabilities of mail server. */
#define CAPABILITY_NONE                 0x00
#define CAPABILITY_NAMESPACE            0x01

/* Flags for logger. */
#define LOG_WRITE                       0
#define LOG_SERVER                      1
#define LOG_USERNAME                    2
#define LOG_MAILBOX                     3
#define LOG_FILTER                      4
#define LOG_ACTION                      5
#define LOG_DESTINATION_MAILBOX         6

/* Buffer size of the IMAP command. */
#define SMALL_CMD                       64
#define MEDIUM_CMD                      256
#define BIG_CMD                         8192

/* Buffer size of server's response. */
#define RESPONSE_BUF                    (4096 + 1)
#define RESULT_BUF                      512

/* Response codes. */
#define RESPONSE_BAD                    -1
#define RESPONSE_OK                     0
#define RESPONSE_NO                     1
#define RESPONSE_BYE                    2
#define RESPONSE_PREAUTH                3
#define RESPONSE_READONLY               4
#define RESPONSE_TRYCREATE              5

/* Buffer size of message's headers. */
#define HEADERS_BUF                     16384

/* Length of mailbox namespace prefix. */
#define NAMESPACE_PREFIX_LEN            64


#define min(A, B)                       ((A) < (B) ? (A) : (B))
#define plural(A)                       ((A) == 1 ? "" : "s")


/*      file.c          */
int create_homedir(void);
int create_file(char *fname, mode_t mode);
int create_dir(char *dname, mode_t mode);
#ifdef CHECK_PERMISSIONS
int check_file_perms(char *fname, mode_t mode);
int check_dir_perms(char *dname, mode_t mode);
#endif
int read_config(char *cfg);
int parse_config(FILE * fp);
void set_options(char *line, regmatch_t * match);

/*      imapfilter.c    */
void usage(void);

/*      imap.c          */
unsigned int send_command(char *cmd);
#ifdef DEBUG
int imap_noop(void);
#endif
int imap_capability(void);
int imap_namespace(void);
int imap_logout(void);
int imap_login(char *user, char *pass);
/* int imap_examine(char *mbox); */
int imap_select(char *mbox);
int imap_status(char *mbox, char *items);
int imap_create(char *mbox);
int imap_search(char *search);
int imap_fetch(char *mesg, char *headers, int peek);
int imap_store(char *mesg, char *flags);
int imap_copy(char *mesg, char *mbox);
int imap_close(void);
/* int imap_expunge(void); */

/*      log.c           */
void info(const char *info,...);
void verbose(const char *info,...);
void error(const char *errmsg,...);
void fatal(unsigned int errnum, const char *fatal,...);
void catch_signals(void);
void signal_handler(int sig);
int open_logfile(void);
int create_logfile(void);
int close_logfile(void);
void log_info(int flag, void *ptr);
char *get_time(void);

/*      memory.c        */
void *xmalloc(size_t size);
void *xrealloc(void *ptr, size_t size);
char *xstrdup(const char *s);

/*      misc.c          */
char *strcasestr(const char *haystack, const char *needle);
char *ultostr(unsigned long int num, int base);
char *xstrncpy(char *dest, const char *src, size_t size);

/*      passwd.c        */
void get_password(char *user, char *serv, char *passwd);
char *base64_encode(char *dest, char *src, int n);
int base64_decode(char *dest, char *src);

/*      request.c       */
int test(void);
int check_capabilities(void);
int check_namespace(void);
int login(char *user, char *pass);
int select_mailbox(char *mbox);
int mailbox_status(char *mbox);
int close_mailbox(void);
int logout(void);

int apply_filters(filter_t ** filters);
int match_filter(filter_t * filter, char **mesgs);

void empty_fifo(mask_t ** mfifo);
void queue_fifo(mask_t ** mfifo, mask_t * mask);
mask_t *dequeue_fifo(mask_t ** mfifo);

char *generate_filter_and(mask_t * mask, unsigned int masknum, unsigned int masklen);
char *generate_filter_or(mask_t * mask, unsigned int masknum, unsigned int masklen);

int apply_action(char *mesgs, unsigned int *type, char *destmbox, char *args);
int action_delete(char *mesgs, char *args);
int action_copy(char *mesgs, char *destmbox, char *args);
int action_move(char *mesgs, char *destmbox, char *args);
int action_list(char *mesgs, char *args);

unsigned int convert_messages(char *mesgs);

/*      response.c      */
void receive_response(char *buf);
int server_response(unsigned int tag);
int greeting_response(void);
int capability_response(unsigned int tag);
int namespace_response(unsigned int tag, char *prefix, char delim);
int status_response(unsigned int tag, char *mbox);
int select_response(unsigned int tag);
int search_response(unsigned int tag, char **mesgs);
int fetch_response(unsigned int tag);
int copy_response(unsigned int tag);
int analyze_response(char *buf);

/*      socket.c        */
#ifndef SSL_TLS
int init_connection(char *serv, unsigned short int port);
#else
int init_connection(char *serv, unsigned short int port, unsigned int protocol);
#endif
int ssl_init(unsigned int protocol);
int close_connection(void);
int socket_read(char *buf);
int socket_write(char *data);

/*      tty.c           */
int tty_store(void);
int tty_disable_echo(void);
int tty_restore(void);

#endif                          /* IMAPFILTER_H */
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.9
9			#ifndef DATA_H
10			#include "data.h"
11			#endif
12
13	lefcha	1.11	/* Error codes returned by functions. */
14	lefcha	1.22	#define ERROR_SIGNAL 1
15			#define ERROR_TRIVIAL 2
16			#define ERROR_FILE_OPEN 3
17			#define ERROR_CONFIG_PARSE 4
18			#define ERROR_MEMORY_ALLOCATION 5
19	lefcha	1.25	#define ERROR_TERMIO 6
20			#define ERROR_NETWORK 7
21			#define ERROR_SSL 8
22			#define ERROR_UNDEFINED 9
23	lefcha	1.9
24			/* Flags that control the program's options. */
25	lefcha	1.16	#define OPTION_DETAILS_QUIET 0x01
26	lefcha	1.9	#define OPTION_DETAILS_NORMAL 0x02
27			#define OPTION_DETAILS_VERBOSE 0x04
28			#define OPTION_DETAILS_CLEAR 0xf8
29	lefcha	1.14	#define OPTION_HEADERS 0x08
30	lefcha	1.25	#define OPTION_NAMESPACE 0x10
31
32			/* Capabilities of mail server. */
33			#define CAPABILITY_NONE 0x00
34			#define CAPABILITY_NAMESPACE 0x01
35	lefcha	1.9
36	lefcha	1.12	/* Flags for logger. */
37			#define LOG_WRITE 0
38			#define LOG_SERVER 1
39			#define LOG_USERNAME 2
40			#define LOG_MAILBOX 3
41			#define LOG_FILTER 4
42			#define LOG_ACTION 5
43			#define LOG_DESTINATION_MAILBOX 6
44
45	lefcha	1.17	/* Buffer size of the IMAP command. */
46	lefcha	1.9	#define SMALL_CMD 64
47			#define MEDIUM_CMD 256
48			#define BIG_CMD 8192
49
50			/* Buffer size of server's response. */
51	lefcha	1.21	#define RESPONSE_BUF (4096 + 1)
52	lefcha	1.20	#define RESULT_BUF 512
53	lefcha	1.9
54	lefcha	1.16	/* Response codes. */
55			#define RESPONSE_BAD -1
56			#define RESPONSE_OK 0
57			#define RESPONSE_NO 1
58			#define RESPONSE_BYE 2
59	lefcha	1.20	#define RESPONSE_PREAUTH 3
60			#define RESPONSE_READONLY 4
61			#define RESPONSE_TRYCREATE 5
62	lefcha	1.16
63	lefcha	1.9	/* Buffer size of message's headers. */
64	lefcha	1.19	#define HEADERS_BUF 16384
65	lefcha	1.9
66	lefcha	1.25	/* Length of mailbox namespace prefix. */
67			#define NAMESPACE_PREFIX_LEN 64
68
69	lefcha	1.1
70			#define min(A, B) ((A) < (B) ? (A) : (B))
71	lefcha	1.15	#define plural(A) ((A) == 1 ? "" : "s")
72	lefcha	1.1
73
74	lefcha	1.9	/* file.c */
75	lefcha	1.25	int create_homedir(void);
76			int create_file(char *fname, mode_t mode);
77			int create_dir(char *dname, mode_t mode);
78	lefcha	1.9	#ifdef CHECK_PERMISSIONS
79	lefcha	1.25	int check_file_perms(char *fname, mode_t mode);
80			int check_dir_perms(char *dname, mode_t mode);
81	lefcha	1.9	#endif
82	lefcha	1.25	int read_config(char *cfg);
83	lefcha	1.9	int parse_config(FILE * fp);
84	lefcha	1.10	void set_options(char line, regmatch_t match);
85	lefcha	1.1
86	lefcha	1.9	/* imapfilter.c */
87			void usage(void);
88	lefcha	1.1
89	lefcha	1.9	/* imap.c */
90	lefcha	1.16	unsigned int send_command(char *cmd);
91	lefcha	1.9	#ifdef DEBUG
92			int imap_noop(void);
93			#endif
94	lefcha	1.16	int imap_capability(void);
95	lefcha	1.25	int imap_namespace(void);
96	lefcha	1.9	int imap_logout(void);
97			int imap_login(char user, char pass);
98	lefcha	1.16	/* int imap_examine(char mbox); /
99	lefcha	1.9	int imap_select(char *mbox);
100			int imap_status(char mbox, char items);
101			int imap_create(char *mbox);
102			int imap_search(char *search);
103	lefcha	1.16	int imap_fetch(char mesg, char headers, int peek);
104	lefcha	1.9	int imap_store(char mesg, char flags);
105			int imap_copy(char mesg, char mbox);
106			int imap_close(void);
107	lefcha	1.23	/* int imap_expunge(void); */
108	lefcha	1.9
109			/* log.c */
110	lefcha	1.13	void info(const char *info,...);
111			void verbose(const char *info,...);
112			void error(const char *errmsg,...);
113			void fatal(unsigned int errnum, const char *fatal,...);
114	lefcha	1.22	void catch_signals(void);
115			void signal_handler(int sig);
116	lefcha	1.9	int open_logfile(void);
117			int create_logfile(void);
118			int close_logfile(void);
119	lefcha	1.12	void log_info(int flag, void *ptr);
120	lefcha	1.11	char *get_time(void);
121	lefcha	1.9
122	lefcha	1.13	/* memory.c */
123			void *xmalloc(size_t size);
124	lefcha	1.19	void xrealloc(void ptr, size_t size);
125	lefcha	1.13	char xstrdup(const char s);
126
127	lefcha	1.16	/* misc.c */
128			char strcasestr(const char haystack, const char *needle);
129			char *ultostr(unsigned long int num, int base);
130	lefcha	1.24	char xstrncpy(char dest, const char *src, size_t size);
131	lefcha	1.16
132	lefcha	1.25	/* passwd.c */
133			void get_password(char user, char serv, char *passwd);
134			char base64_encode(char dest, char *src, int n);
135			int base64_decode(char dest, char src);
136
137	lefcha	1.9	/* request.c */
138			int test(void);
139	lefcha	1.16	int check_capabilities(void);
140	lefcha	1.25	int check_namespace(void);
141	lefcha	1.9	int login(char user, char pass);
142			int select_mailbox(char *mbox);
143	lefcha	1.11	int mailbox_status(char *mbox);
144	lefcha	1.9	int close_mailbox(void);
145			int logout(void);
146
147	lefcha	1.16	int apply_filters(filter_t ** filters);
148	lefcha	1.19	int match_filter(filter_t * filter, char **mesgs);
149	lefcha	1.9
150			void empty_fifo(mask_t ** mfifo);
151	lefcha	1.11	void queue_fifo(mask_t ** mfifo, mask_t * mask);
152			mask_t dequeue_fifo(mask_t * mfifo);
153	lefcha	1.9
154	lefcha	1.11	char generate_filter_and(mask_t mask, unsigned int masknum, unsigned int masklen);
155			char generate_filter_or(mask_t mask, unsigned int masknum, unsigned int masklen);
156	lefcha	1.9
157	lefcha	1.11	int apply_action(char mesgs, unsigned int type, char destmbox, char args);
158	lefcha	1.9	int action_delete(char mesgs, char args);
159	lefcha	1.11	int action_copy(char mesgs, char destmbox, char *args);
160			int action_move(char mesgs, char destmbox, char *args);
161			int action_list(char mesgs, char args);
162	lefcha	1.9
163			unsigned int convert_messages(char *mesgs);
164
165	lefcha	1.11	/* response.c */
166	lefcha	1.20	void receive_response(char *buf);
167	lefcha	1.16	int server_response(unsigned int tag);
168			int greeting_response(void);
169			int capability_response(unsigned int tag);
170	lefcha	1.25	int namespace_response(unsigned int tag, char *prefix, char delim);
171	lefcha	1.23	int status_response(unsigned int tag, char *mbox);
172	lefcha	1.16	int select_response(unsigned int tag);
173	lefcha	1.19	int search_response(unsigned int tag, char **mesgs);
174	lefcha	1.16	int fetch_response(unsigned int tag);
175			int copy_response(unsigned int tag);
176	lefcha	1.20	int analyze_response(char *buf);
177	lefcha	1.25
178			/* socket.c */
179			#ifndef SSL_TLS
180			int init_connection(char *serv, unsigned short int port);
181			#else
182			int init_connection(char *serv, unsigned short int port, unsigned int protocol);
183			#endif
184			int ssl_init(unsigned int protocol);
185			int close_connection(void);
186			int socket_read(char *buf);
187			int socket_write(char *data);
188
189			/* tty.c */
190			int tty_store(void);
191			int tty_disable_echo(void);
192			int tty_restore(void);
193	lefcha	1.11
194	lefcha	1.13	#endif /* IMAPFILTER_H */