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];
62 /* Data structure returned by validate_recipients() */
82 #define RECPTYPES_MAGIC 0xfeeb
85 * This is a list of "harvested" email addresses that we might want to
86 * stick into someone's address book. But we defer this operaiton so
87 * it can be done asynchronously.
89 struct addresses_to_be_filed {
90 struct addresses_to_be_filed *next;
92 char *collected_addresses;
95 extern struct addresses_to_be_filed *atbf;
97 int alias (char *name);
98 void cmd_msgs (char *cmdbuf);
99 void cmd_isme (char *cmdbuf);
100 void help_subst (char *strbuf, char *source, char *dest);
101 void do_help_subst (char *buffer);
102 void memfmout (char *mptr, const char *nl);
103 void output_mime_parts(char *);
104 void cmd_msg0 (char *cmdbuf);
105 void cmd_msg2 (char *cmdbuf);
106 void cmd_msg3 (char *cmdbuf);
107 void cmd_msg4 (char *cmdbuf);
108 void cmd_msgp (char *cmdbuf);
109 void cmd_opna (char *cmdbuf);
110 void cmd_dlat (char *cmdbuf);
111 long send_message (struct CtdlMessage *);
112 void loadtroom (void);
113 long CtdlSubmitMsg(struct CtdlMessage *, struct recptypes *, const char *, int);
115 void quickie_message(const char *from,
116 const char *fromaddr,
121 const char *subject);
123 void flood_protect_quickie_message(const char *from,
124 const char *fromaddr,
131 const char **CritStr,
134 void cmd_ent0 (char *entargs);
135 void cmd_dele (char *delstr);
136 void cmd_move (char *args);
137 void GetMetaData(struct MetaData *, long);
138 void PutMetaData(struct MetaData *);
139 void AdjRefCount(long, int);
140 void TDAP_AdjRefCount(long, int);
141 int TDAP_ProcessAdjRefCountQueue(void);
142 void simple_listing(long, void *);
143 int CtdlMsgCmp(struct CtdlMessage *msg, struct CtdlMessage *template);
144 typedef void (*ForEachMsgCallback)(long MsgNumber, void *UserData);
145 int CtdlForEachMessage(int mode,
149 struct CtdlMessage *compare,
150 ForEachMsgCallback CallBack,
152 int CtdlDeleteMessages(char *, long *, int, char *);
153 void CtdlWriteObject(char *req_room, /* Room to stuff it in */
154 char *content_type, /* MIME type of this object */
155 char *raw_message, /* Data to be written */
156 off_t raw_length, /* Size of raw_message */
157 struct ctdluser *is_mailbox, /* Mailbox room? */
158 int is_binary, /* Is encoding necessary? */
159 int is_unique, /* Del others of this type? */
160 unsigned int flags /* Internal save flags */
162 struct CtdlMessage *CtdlFetchMessage(long msgnum, int with_body);
163 struct CtdlMessage * CtdlDuplicateMessage(struct CtdlMessage *OrgMsg);
164 void CtdlFreeMessage(struct CtdlMessage *msg);
165 void CtdlFreeMessageContents(struct CtdlMessage *msg);
166 void serialize_message(struct ser_ret *, struct CtdlMessage *);
167 int is_valid_message(struct CtdlMessage *);
168 void ReplicationChecks(struct CtdlMessage *);
169 int CtdlSaveMsgPointersInRoom(char *roomname, long newmsgidlist[], int num_newmsgs,
170 int do_repl_check, struct CtdlMessage *supplied_msg, int suppress_refcount_adj);
171 int CtdlSaveMsgPointerInRoom(char *roomname, long msgid, int do_repl_check, struct CtdlMessage *msg);
172 char *CtdlReadMessageBody(char *terminator, long tlen, size_t maxlen, StrBuf *exist, int crlf, int *sock);
173 StrBuf *CtdlReadMessageBodyBuf(char *terminator, /* token signalling EOT */
175 size_t maxlen, /* maximum message length */
176 StrBuf *exist, /* if non-null, append to it;
177 exist is ALWAYS freed */
178 int crlf, /* CRLF newlines instead of LF */
179 int *sock /* socket handle or 0 for this session's client socket */
182 int CtdlOutputMsg(long msg_num, /* message number (local) to fetch */
183 int mode, /* how would you like that message? */
184 int headers_only, /* eschew the message body? */
185 int do_proto, /* do Citadel protocol responses? */
186 int crlf, /* 0=LF, 1=CRLF */
187 char *section, /* output a message/rfc822 section */
188 int flags, /* should the bessage be exported clean? */
189 char **Author, /* if you want to know the author of the message... */
190 char **Address /* if you want to know the sender address of the message... */
193 /* Flags which may be passed to CtdlOutputMsg() and CtdlOutputPreLoadedMsg() */
194 #define QP_EADDR (1<<0) /* quoted-printable encode email addresses */
196 #define ESC_DOT (1<<2) /* output a line containing only "." as ".." instead */
197 #define SUPPRESS_ENV_TO (1<<3) /* suppress Envelope-to: header (warning: destructive!) */
199 int CtdlOutputPreLoadedMsg(struct CtdlMessage *,
200 int mode, /* how would you like that message? */
201 int headers_only, /* eschew the message body? */
202 int do_proto, /* do Citadel protocol responses? */
203 int crlf, /* 0=LF, 1=CRLF */
204 int flags /* should the bessage be exported clean? */
206 int CtdlDoIHavePermissionToDeleteMessagesFromThisRoom(void);
207 int CtdlDoIHavePermissionToReadMessagesInThisRoom(void);
216 int CtdlDoIHavePermissionToPostInThisRoom(char *errmsgbuf,
218 const char* RemoteIdentifier,
224 /* values for which_set */
229 void CtdlSetSeen(long *target_msgnums, int num_target_msgnums,
230 int target_setting, int which_set,
231 struct ctdluser *which_user, struct ctdlroom *which_room);
232 void CtdlGetSeen(char *buf, int which_set);
234 struct recptypes *validate_recipients(const char *recipients,
235 const char *RemoteIdentifier,
238 void free_recipients(struct recptypes *);
240 struct CtdlMessage *CtdlMakeMessage(
241 struct ctdluser *author, /* author's user structure */
242 char *recipient, /* NULL if it's not mail */
243 char *recp_cc, /* NULL if it's not mail */
244 char *room, /* room where it's going */
245 int type, /* see MES_ types in header file */
246 int format_type, /* variformat, plain text, MIME... */
247 char *fake_name, /* who we're masquerading as */
248 char *my_email, /* which of my email addresses to use (empty is ok) */
249 char *subject, /* Subject (optional) */
250 char *supplied_euid, /* ...or NULL if this is irrelevant */
251 char *preformatted_text, /* ...or NULL to read text from client */
252 char *references /* Thread references */
254 int CtdlCheckInternetMailPermission(struct ctdluser *who);
255 int CtdlIsMe(char *addr, int addr_buf_len);
258 * loading messages async via an FD:
259 * add IO->ReadMsg = NewAsyncMsg(...)
260 * and then call CtdlReadMessageBodyAsync() from your linreader handler.
263 ReadAsyncMsg *NewAsyncMsg(const char *terminator, /* token signalling EOT */
265 size_t expectlen, /* if we expect a message, how long should it be? */
266 size_t maxlen, /* maximum message length */
267 StrBuf *exist, /* if non-null, append to it;
268 exist is ALWAYS freed */
269 long eLen, /* length of exist */
270 int crlf /* CRLF newlines instead of LF */
273 eReadState CtdlReadMessageBodyAsync(AsyncIO *IO);
274 void DeleteAsyncMsg(ReadAsyncMsg **Msg);
276 extern int MessageDebugEnabled;
278 #define MSGDBGLOG(LEVEL) if ((LEVEL != LOG_DEBUG) || (MessageDebugEnabled != 0))
279 #define CCCID CCC->cs_pid
280 #define MSG_syslog(LEVEL, FORMAT, ...) \
281 MSGDBGLOG(LEVEL) syslog(LEVEL, \
282 "CC[%d]MSG" FORMAT, \
285 #define MSGM_syslog(LEVEL, FORMAT) \
286 MSGDBGLOG(LEVEL) syslog(LEVEL, \
287 "CC[%d]MSG" FORMAT, \
292 #endif /* MSGBASE_H */