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);
114 void quickie_message (const char *, const char *, char *, char *, const char *, int, const char *);
115 void cmd_ent0 (char *entargs);
116 void cmd_dele (char *delstr);
117 void cmd_move (char *args);
118 void GetMetaData(struct MetaData *, long);
119 void PutMetaData(struct MetaData *);
120 void AdjRefCount(long, int);
121 void TDAP_AdjRefCount(long, int);
122 int TDAP_ProcessAdjRefCountQueue(void);
123 void simple_listing(long, void *);
124 int CtdlMsgCmp(struct CtdlMessage *msg, struct CtdlMessage *template);
125 typedef void (*ForEachMsgCallback)(long MsgNumber, void *UserData);
126 int CtdlForEachMessage(int mode,
130 struct CtdlMessage *compare,
131 ForEachMsgCallback CallBack,
133 int CtdlDeleteMessages(char *, long *, int, char *);
134 void CtdlWriteObject(char *req_room, /* Room to stuff it in */
135 char *content_type, /* MIME type of this object */
136 char *raw_message, /* Data to be written */
137 off_t raw_length, /* Size of raw_message */
138 struct ctdluser *is_mailbox, /* Mailbox room? */
139 int is_binary, /* Is encoding necessary? */
140 int is_unique, /* Del others of this type? */
141 unsigned int flags /* Internal save flags */
143 struct CtdlMessage *CtdlFetchMessage(long msgnum, int with_body);
144 void CtdlFreeMessage(struct CtdlMessage *msg);
145 void CtdlFreeMessageContents(struct CtdlMessage *msg);
146 void serialize_message(struct ser_ret *, struct CtdlMessage *);
147 void dump_message(struct CtdlMessage *msg, long Siz);
148 int is_valid_message(struct CtdlMessage *);
149 void ReplicationChecks(struct CtdlMessage *);
150 int CtdlSaveMsgPointersInRoom(char *roomname, long newmsgidlist[], int num_newmsgs,
151 int do_repl_check, struct CtdlMessage *supplied_msg, int suppress_refcount_adj);
152 int CtdlSaveMsgPointerInRoom(char *roomname, long msgid, int do_repl_check, struct CtdlMessage *msg);
153 char *CtdlReadMessageBody(char *terminator, long tlen, size_t maxlen, char *exist, int crlf, int *sock);
154 StrBuf *CtdlReadMessageBodyBuf(char *terminator, /* token signalling EOT */
156 size_t maxlen, /* maximum message length */
157 char *exist, /* if non-null, append to it;
158 exist is ALWAYS freed */
159 int crlf, /* CRLF newlines instead of LF */
160 int *sock /* socket handle or 0 for this session's client socket */
163 int CtdlOutputMsg(long msg_num, /* message number (local) to fetch */
164 int mode, /* how would you like that message? */
165 int headers_only, /* eschew the message body? */
166 int do_proto, /* do Citadel protocol responses? */
167 int crlf, /* 0=LF, 1=CRLF */
168 char *section, /* output a message/rfc822 section */
169 int flags /* should the bessage be exported clean? */
172 /* Flags which may be passed to CtdlOutputMsg() and CtdlOutputPreLoadedMsg() */
173 #define QP_EADDR (1<<0) /* quoted-printable encode email addresses */
175 #define ESC_DOT (1<<2) /* output a line containing only "." as ".." instead */
176 #define SUPPRESS_ENV_TO (1<<3) /* suppress Envelope-to: header (warning: destructive!) */
178 int CtdlOutputPreLoadedMsg(struct CtdlMessage *,
179 int mode, /* how would you like that message? */
180 int headers_only, /* eschew the message body? */
181 int do_proto, /* do Citadel protocol responses? */
182 int crlf, /* 0=LF, 1=CRLF */
183 int flags /* should the bessage be exported clean? */
185 int CtdlDoIHavePermissionToDeleteMessagesFromThisRoom(void);
186 int CtdlDoIHavePermissionToReadMessagesInThisRoom(void);
195 int CtdlDoIHavePermissionToPostInThisRoom(char *errmsgbuf,
197 const char* RemoteIdentifier,
203 /* values for which_set */
208 void CtdlSetSeen(long *target_msgnums, int num_target_msgnums,
209 int target_setting, int which_set,
210 struct ctdluser *which_user, struct ctdlroom *which_room);
211 void CtdlGetSeen(char *buf, int which_set);
213 struct recptypes *validate_recipients(const char *recipients,
214 const char *RemoteIdentifier,
217 void free_recipients(struct recptypes *);
219 struct CtdlMessage *CtdlMakeMessage(
220 struct ctdluser *author, /* author's user structure */
221 char *recipient, /* NULL if it's not mail */
222 char *recp_cc, /* NULL if it's not mail */
223 char *room, /* room where it's going */
224 int type, /* see MES_ types in header file */
225 int format_type, /* variformat, plain text, MIME... */
226 char *fake_name, /* who we're masquerading as */
227 char *my_email, /* which of my email addresses to use (empty is ok) */
228 char *subject, /* Subject (optional) */
229 char *supplied_euid, /* ...or NULL if this is irrelevant */
230 char *preformatted_text, /* ...or NULL to read text from client */
231 char *references /* Thread references */
233 int CtdlCheckInternetMailPermission(struct ctdluser *who);
234 int CtdlIsMe(char *addr, int addr_buf_len);
237 * Use of aide_message is deprecated.
238 * It has been replaced with CtdlAideMessage.
239 * All parameters remain the same.
241 void aide_message(char *text, char *subject) __attribute__ ((deprecated));
245 * loading messages async via an FD:
246 * add IO->ReadMsg = NewAsyncMsg(...)
247 * and then call CtdlReadMessageBodyAsync() from your linreader handler.
250 ReadAsyncMsg *NewAsyncMsg(const char *terminator, /* token signalling EOT */
252 size_t expectlen, /* if we expect a message, how long should it be? */
253 size_t maxlen, /* maximum message length */
254 char *exist, /* if non-null, append to it;
255 exist is ALWAYS freed */
256 long eLen, /* length of exist */
257 int crlf /* CRLF newlines instead of LF */
260 eReadState CtdlReadMessageBodyAsync(AsyncIO *IO);
261 void DeleteAsyncMsg(ReadAsyncMsg **Msg);
265 #endif /* MSGBASE_H */