Replaced cached_msglist array with a btree persistent through the session.
[citadel.git] / citadel / msgbase.h
1
2 #ifndef MSGBASE_H
3 #define MSGBASE_H
4
5 #include "event_client.h"
6 enum {
7         MSGS_ALL,
8         MSGS_OLD,
9         MSGS_NEW,
10         MSGS_FIRST,
11         MSGS_LAST,
12         MSGS_GT,
13         MSGS_EQ,
14         MSGS_SEARCH,
15         MSGS_LT
16 };
17
18 enum {
19         MSG_HDRS_BRIEF = 0,
20         MSG_HDRS_ALL = 1,
21         MSG_HDRS_EUID = 4
22 };
23
24 /*
25  * Possible return codes from CtdlOutputMsg()
26  */
27 enum {
28         om_ok,
29         om_not_logged_in,
30         om_no_such_msg,
31         om_mime_error,
32         om_access_denied
33 };
34
35 /*
36  * Values of "headers_only" when calling message output routines
37  */
38 #define HEADERS_ALL     0       /* Headers and body */
39 #define HEADERS_ONLY    1       /* Headers only */
40 #define HEADERS_NONE    2       /* Body only */
41 #define HEADERS_FAST    3       /* Headers only with no MIME info */
42
43
44 struct ma_info {
45         int is_ma;              /* Set to 1 if we are using this stuff */
46         int freeze;             /* Freeze the replacement chain because we're
47                                  * digging through a subsection */
48         int did_print;          /* One alternative has been displayed */
49         char chosen_part[128];  /* Which part of a m/a did we choose? */
50         int chosen_pref;        /* Chosen part preference level (lower is better) */
51         int use_fo_hooks;       /* Use fixed output hooks */
52         int dont_decode;        /* should we call the decoder or not? */
53 };
54
55
56 struct repl {                   /* Info for replication checking */
57         char exclusive_id[SIZ];
58         time_t highest;
59 };
60
61
62 /* Data structure returned by validate_recipients() */
63 struct recptypes {
64         int recptypes_magic;
65         int num_local;
66         int num_internet;
67         int num_ignet;
68         int num_room;
69         int num_error;
70         char *errormsg;
71         char *recp_local;
72         char *recp_internet;
73         char *recp_ignet;
74         char *recp_room;
75         char *display_recp;
76         char *bounce_to;
77         char *envelope_from;
78 };
79
80 #define RECPTYPES_MAGIC 0xfeeb
81
82 /*
83  * This is a list of "harvested" email addresses that we might want to
84  * stick into someone's address book.  But we defer this operaiton so
85  * it can be done asynchronously.
86  */
87 struct addresses_to_be_filed {
88         struct addresses_to_be_filed *next;
89         char *roomname;
90         char *collected_addresses;
91 };
92
93 extern struct addresses_to_be_filed *atbf;
94
95 int alias (char *name);
96 void cmd_msgs (char *cmdbuf);
97 void cmd_isme (char *cmdbuf);
98 void help_subst (char *strbuf, char *source, char *dest);
99 void do_help_subst (char *buffer);
100 void memfmout (char *mptr, const char *nl);
101 void output_mime_parts(char *);
102 void cmd_msg0 (char *cmdbuf);
103 void cmd_msg2 (char *cmdbuf);
104 void cmd_msg3 (char *cmdbuf);
105 void cmd_msg4 (char *cmdbuf);
106 void cmd_msgp (char *cmdbuf);
107 void cmd_opna (char *cmdbuf);
108 void cmd_dlat (char *cmdbuf);
109 long send_message (struct CtdlMessage *);
110 void loadtroom (void);
111 long CtdlSubmitMsg(struct CtdlMessage *, struct recptypes *, const char *, int);
112 void quickie_message (const char *, const char *, char *, char *, const char *, int, const char *);
113 void cmd_ent0 (char *entargs);
114 void cmd_dele (char *delstr);
115 void cmd_move (char *args);
116 void GetMetaData(struct MetaData *, long);
117 void PutMetaData(struct MetaData *);
118 void AdjRefCount(long, int);
119 void TDAP_AdjRefCount(long, int);
120 int TDAP_ProcessAdjRefCountQueue(void);
121 void simple_listing(long, void *);
122 int CtdlMsgCmp(struct CtdlMessage *msg, struct CtdlMessage *template);
123 typedef void (*ForEachMsgCallback)(long MsgNumber, void *UserData);
124 int CtdlForEachMessage(int mode,
125                         long ref,
126                         char *searchstring,
127                         char *content_type,
128                         struct CtdlMessage *compare,
129                         ForEachMsgCallback CallBack,
130                         void *userdata);
131 int CtdlDeleteMessages(char *, long *, int, char *);
132 void CtdlWriteObject(char *req_room,                    /* Room to stuff it in */
133                         char *content_type,             /* MIME type of this object */
134                         char *raw_message,              /* Data to be written */
135                         off_t raw_length,               /* Size of raw_message */
136                         struct ctdluser *is_mailbox,    /* Mailbox room? */
137                         int is_binary,                  /* Is encoding necessary? */
138                         int is_unique,                  /* Del others of this type? */
139                         unsigned int flags              /* Internal save flags */
140 );
141 struct CtdlMessage *CtdlFetchMessage(long msgnum, int with_body);
142 void CtdlFreeMessage(struct CtdlMessage *msg);
143 void serialize_message(struct ser_ret *, struct CtdlMessage *);
144 void dump_message(struct CtdlMessage *msg, long Siz);
145 int is_valid_message(struct CtdlMessage *);
146 void ReplicationChecks(struct CtdlMessage *);
147 int CtdlSaveMsgPointersInRoom(char *roomname, long newmsgidlist[], int num_newmsgs,
148                         int do_repl_check, struct CtdlMessage *supplied_msg, int suppress_refcount_adj);
149 int CtdlSaveMsgPointerInRoom(char *roomname, long msgid, int do_repl_check, struct CtdlMessage *msg);
150 char *CtdlReadMessageBody(char *terminator, long tlen, size_t maxlen, char *exist, int crlf, int *sock);
151 StrBuf *CtdlReadMessageBodyBuf(char *terminator,        /* token signalling EOT */
152                                long tlen,
153                                size_t maxlen,           /* maximum message length */
154                                char *exist,             /* if non-null, append to it;
155                                                            exist is ALWAYS freed  */
156                                int crlf,                /* CRLF newlines instead of LF */
157                                int *sock                /* socket handle or 0 for this session's client socket */
158         );
159
160 int CtdlOutputMsg(long msg_num,         /* message number (local) to fetch */
161                   int mode,             /* how would you like that message? */
162                   int headers_only,     /* eschew the message body? */
163                   int do_proto,         /* do Citadel protocol responses? */
164                   int crlf,             /* 0=LF, 1=CRLF */
165                   char *section,                /* output a message/rfc822 section */
166                   int flags             /* should the bessage be exported clean? */
167 );
168
169 /* Flags which may be passed to CtdlOutputMsg() and CtdlOutputPreLoadedMsg() */
170 #define QP_EADDR        (1<<0)          /* quoted-printable encode email addresses */
171 #define CRLF            (1<<1)
172 #define ESC_DOT         (1<<2)          /* output a line containing only "." as ".." instead */
173 #define SUPPRESS_ENV_TO (1<<3)          /* suppress Envelope-to: header (warning: destructive!) */
174
175 int CtdlOutputPreLoadedMsg(struct CtdlMessage *,
176                            int mode,            /* how would you like that message? */
177                            int headers_only,    /* eschew the message body? */
178                            int do_proto,        /* do Citadel protocol responses? */
179                            int crlf,            /* 0=LF, 1=CRLF */
180                            int flags            /* should the bessage be exported clean? */
181 );
182 int CtdlDoIHavePermissionToDeleteMessagesFromThisRoom(void);
183 int CtdlDoIHavePermissionToReadMessagesInThisRoom(void);
184
185 enum {
186         POST_LOGGED_IN,
187         POST_EXTERNAL,
188         CHECK_EXISTANCE,
189         POST_LMTP
190 };
191
192 int CtdlDoIHavePermissionToPostInThisRoom(char *errmsgbuf, 
193         size_t n, 
194         const char* RemoteIdentifier,
195         int PostPublic,
196         int is_reply
197 );
198
199
200 /* values for which_set */
201 enum {
202         ctdlsetseen_seen,
203         ctdlsetseen_answered
204 };
205 void CtdlSetSeen(long *target_msgnums, int num_target_msgnums,
206                  int target_setting, int which_set,
207                 struct ctdluser *which_user, struct ctdlroom *which_room);
208 void CtdlGetSeen(char *buf, int which_set);
209
210 struct recptypes *validate_recipients(const char *recipients,
211                                       const char *RemoteIdentifier, 
212                                       int Flags);
213
214 void free_recipients(struct recptypes *);
215
216 struct CtdlMessage *CtdlMakeMessage(
217         struct ctdluser *author,        /* author's user structure */
218         char *recipient,                /* NULL if it's not mail */
219         char *recp_cc,                  /* NULL if it's not mail */
220         char *room,                     /* room where it's going */
221         int type,                       /* see MES_ types in header file */
222         int format_type,                /* variformat, plain text, MIME... */
223         char *fake_name,                /* who we're masquerading as */
224         char *my_email,                 /* which of my email addresses to use (empty is ok) */
225         char *subject,                  /* Subject (optional) */
226         char *supplied_euid,            /* ...or NULL if this is irrelevant */
227         char *preformatted_text,        /* ...or NULL to read text from client */
228         char *references                /* Thread references */
229 );
230 int CtdlCheckInternetMailPermission(struct ctdluser *who);
231 int CtdlIsMe(char *addr, int addr_buf_len);
232
233 /*
234  * Use of aide_message is deprecated.
235  * It has been replaced with CtdlAideMessage.
236  * All parameters remain the same.
237 */
238 void aide_message(char *text, char *subject) __attribute__ ((deprecated));
239
240 void seenit_store(struct seenit **si, long msgnum);
241 int seenit_isthere(struct seenit *si, long msgnum);
242 void seenit_free(struct seenit **si);
243
244
245
246 /* 
247  * loading messages async via an FD: 
248  * add IO->ReadMsg = NewAsyncMsg(...)
249  * and then call CtdlReadMessageBodyAsync() from your linreader handler.
250  */
251
252 ReadAsyncMsg *NewAsyncMsg(const char *terminator,       /* token signalling EOT */
253                           long tlen,
254                           size_t expectlen,             /* if we expect a message, how long should it be? */
255                           size_t maxlen,                /* maximum message length */
256                           char *exist,                  /* if non-null, append to it;
257                                                            exist is ALWAYS freed  */
258                           long eLen,                    /* length of exist */
259                           int crlf                      /* CRLF newlines instead of LF */
260         );
261
262 eReadState CtdlReadMessageBodyAsync(AsyncIO *IO);
263 void DeleteAsyncMsg(ReadAsyncMsg **Msg);
264
265
266
267 #endif /* MSGBASE_H */