5 #include "event_client.h"
25 * Possible return codes from CtdlOutputMsg()
36 * Values of "headers_only" when calling message output routines
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 */
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? */
56 struct repl { /* Info for replication checking */
57 char exclusive_id[SIZ];
64 * This is a list of "harvested" email addresses that we might want to
65 * stick into someone's address book. But we defer this operaiton so
66 * it can be done asynchronously.
68 struct addresses_to_be_filed {
69 struct addresses_to_be_filed *next;
71 char *collected_addresses;
74 extern struct addresses_to_be_filed *atbf;
76 void memfmout (char *mptr, const char *nl);
77 void output_mime_parts(char *);
78 long send_message (struct CtdlMessage *);
79 void loadtroom (void);
80 long CtdlSubmitMsg(struct CtdlMessage *, recptypes *, const char *, int);
82 void quickie_message(const char *from,
90 void flood_protect_quickie_message(const char *from,
104 void GetMetaData(struct MetaData *, long);
105 void PutMetaData(struct MetaData *);
106 void AdjRefCount(long, int);
107 void TDAP_AdjRefCount(long, int);
108 int TDAP_ProcessAdjRefCountQueue(void);
109 void simple_listing(long, void *);
110 int CtdlMsgCmp(struct CtdlMessage *msg, struct CtdlMessage *template);
111 typedef void (*ForEachMsgCallback)(long MsgNumber, void *UserData);
112 int CtdlForEachMessage(int mode,
116 struct CtdlMessage *compare,
117 ForEachMsgCallback CallBack,
119 int CtdlDeleteMessages(char *, long *, int, char *);
120 void CtdlWriteObject(char *req_room, /* Room to stuff it in */
121 char *content_type, /* MIME type of this object */
122 char *raw_message, /* Data to be written */
123 off_t raw_length, /* Size of raw_message */
124 struct ctdluser *is_mailbox, /* Mailbox room? */
125 int is_binary, /* Is encoding necessary? */
126 int is_unique, /* Del others of this type? */
127 unsigned int flags /* Internal save flags */
129 struct CtdlMessage *CtdlFetchMessage(long msgnum, int with_body);
130 struct CtdlMessage * CM_Duplicate
131 (struct CtdlMessage *OrgMsg);
132 int CM_IsEmpty (struct CtdlMessage *Msg, eMsgField which);
133 void CM_SetField (struct CtdlMessage *Msg, eMsgField which, const char *buf, long length);
134 void CM_SetFieldLONG (struct CtdlMessage *Msg, eMsgField which, long lvalue);
135 void CM_CopyField (struct CtdlMessage *Msg, eMsgField WhichToPutTo, eMsgField WhichtToCopy);
136 void CM_CutFieldAt (struct CtdlMessage *Msg, eMsgField WhichToCut, long maxlen);
137 void CM_FlushField (struct CtdlMessage *Msg, eMsgField which);
138 void CM_Flush (struct CtdlMessage *Msg);
139 void CM_SetAsField (struct CtdlMessage *Msg, eMsgField which, char **buf, long length);
140 void CM_SetAsFieldSB (struct CtdlMessage *Msg, eMsgField which, StrBuf **buf);
141 void CM_GetAsField (struct CtdlMessage *Msg, eMsgField which, char **ret, long *retlen);
142 void CM_PrependToField (struct CtdlMessage *Msg, eMsgField which, const char *buf, long length);
144 void CM_Free (struct CtdlMessage *msg);
145 void CM_FreeContents (struct CtdlMessage *msg);
146 int CM_IsValidMsg (struct CtdlMessage *msg);
148 #define CM_KEY(Message, Which) Message->cm_fields[Which], Message->cm_lengths[Which]
149 #define CM_RANGE(Message, Which) Message->cm_fields[Which], \
150 Message->cm_fields[Which] + Message->cm_lengths[Which]
152 void CtdlSerializeMessage(struct ser_ret *, struct CtdlMessage *);
153 void ReplicationChecks(struct CtdlMessage *);
154 int CtdlSaveMsgPointersInRoom(char *roomname, long newmsgidlist[], int num_newmsgs,
155 int do_repl_check, struct CtdlMessage *supplied_msg, int suppress_refcount_adj);
156 int CtdlSaveMsgPointerInRoom(char *roomname, long msgid, int do_repl_check, struct CtdlMessage *msg);
157 char *CtdlReadMessageBody(char *terminator, long tlen, size_t maxlen, StrBuf *exist, int crlf, int *sock);
158 StrBuf *CtdlReadMessageBodyBuf(char *terminator, /* token signalling EOT */
160 size_t maxlen, /* maximum message length */
161 StrBuf *exist, /* if non-null, append to it;
162 exist is ALWAYS freed */
163 int crlf, /* CRLF newlines instead of LF */
164 int *sock /* socket handle or 0 for this session's client socket */
167 int CtdlOutputMsg(long msg_num, /* message number (local) to fetch */
168 int mode, /* how would you like that message? */
169 int headers_only, /* eschew the message body? */
170 int do_proto, /* do Citadel protocol responses? */
171 int crlf, /* 0=LF, 1=CRLF */
172 char *section, /* output a message/rfc822 section */
173 int flags, /* should the bessage be exported clean? */
174 char **Author, /* if you want to know the author of the message... */
175 char **Address /* if you want to know the sender address of the message... */
178 /* Flags which may be passed to CtdlOutputMsg() and CtdlOutputPreLoadedMsg() */
179 #define QP_EADDR (1<<0) /* quoted-printable encode email addresses */
181 #define ESC_DOT (1<<2) /* output a line containing only "." as ".." instead */
182 #define SUPPRESS_ENV_TO (1<<3) /* suppress Envelope-to: header (warning: destructive!) */
184 int CtdlOutputPreLoadedMsg(struct CtdlMessage *,
185 int mode, /* how would you like that message? */
186 int headers_only, /* eschew the message body? */
187 int do_proto, /* do Citadel protocol responses? */
188 int crlf, /* 0=LF, 1=CRLF */
189 int flags /* should the bessage be exported clean? */
193 /* values for which_set */
198 void CtdlSetSeen(long *target_msgnums, int num_target_msgnums,
199 int target_setting, int which_set,
200 struct ctdluser *which_user, struct ctdlroom *which_room);
201 void CtdlGetSeen(char *buf, int which_set);
204 struct CtdlMessage *CtdlMakeMessage(
205 struct ctdluser *author, /* author's user structure */
206 char *recipient, /* NULL if it's not mail */
207 char *recp_cc, /* NULL if it's not mail */
208 char *room, /* room where it's going */
209 int type, /* see MES_ types in header file */
210 int format_type, /* variformat, plain text, MIME... */
211 char *fake_name, /* who we're masquerading as */
212 char *my_email, /* which of my email addresses to use (empty is ok) */
213 char *subject, /* Subject (optional) */
214 char *supplied_euid, /* ...or NULL if this is irrelevant */
215 char *preformatted_text, /* ...or NULL to read text from client */
216 char *references /* Thread references */
219 struct CtdlMessage *CtdlMakeMessageLen(
220 struct ctdluser *author, /* author's user structure */
221 char *recipient, /* NULL if it's not mail */
223 char *recp_cc, /* NULL if it's not mail */
225 char *room, /* room where it's going */
227 int type, /* see MES_ types in header file */
228 int format_type, /* variformat, plain text, MIME... */
229 char *fake_name, /* who we're masquerading as */
231 char *my_email, /* which of my email addresses to use (empty is ok) */
233 char *subject, /* Subject (optional) */
235 char *supplied_euid, /* ...or NULL if this is irrelevant */
237 char *preformatted_text, /* ...or NULL to read text from client */
239 char *references, /* Thread references */
243 * loading messages async via an FD:
244 * add IO->ReadMsg = NewAsyncMsg(...)
245 * and then call CtdlReadMessageBodyAsync() from your linreader handler.
248 ReadAsyncMsg *NewAsyncMsg(const char *terminator, /* token signalling EOT */
250 size_t expectlen, /* if we expect a message, how long should it be? */
251 size_t maxlen, /* maximum message length */
252 StrBuf *exist, /* if non-null, append to it;
253 exist is ALWAYS freed */
254 long eLen, /* length of exist */
255 int crlf /* CRLF newlines instead of LF */
258 eReadState CtdlReadMessageBodyAsync(AsyncIO *IO);
259 void DeleteAsyncMsg(ReadAsyncMsg **Msg);
261 extern int MessageDebugEnabled;
263 #define MSGDBGLOG(LEVEL) if ((LEVEL != LOG_DEBUG) || (MessageDebugEnabled != 0))
264 #define CCCID CCC->cs_pid
265 #define MSG_syslog(LEVEL, FORMAT, ...) \
266 MSGDBGLOG(LEVEL) syslog(LEVEL, \
267 "CC[%d]MSG" FORMAT, \
270 #define MSGM_syslog(LEVEL, FORMAT) \
271 MSGDBGLOG(LEVEL) syslog(LEVEL, \
272 "CC[%d]MSG" FORMAT, \
277 #endif /* MSGBASE_H */