* msgbase.c: Added new API function CtdlOutputPreLoadedMsg(), and
[citadel.git] / citadel / msgbase.h
1 /* $Id$ */
2
3 #define aide_message(text)      quickie_message("Citadel",NULL,AIDEROOM,text)
4
5 #define MSGS_ALL        0
6 #define MSGS_OLD        1
7 #define MSGS_NEW        2
8 #define MSGS_FIRST      3
9 #define MSGS_LAST       4
10 #define MSGS_GT         5
11 #define MSGS_EQ         6
12
13 /*
14  * Flags which may be passed to CtdlSaveMsgPointerInRoom()
15  */
16 #define SM_VERIFY_GOODNESS      1       /* Verify this is a real msg number */
17 #define SM_DO_REPL_CHECK        2       /* Perform replication checks */
18 #define SM_DONT_BUMP_REF        4       /* Don't bump reference count
19                                            (use with extreme care!!!!!!) */
20
21
22 /*
23  * Possible return codes from CtdlOutputMsg()
24  */
25 enum {
26         om_ok,
27         om_not_logged_in,
28         om_no_such_msg,
29         om_mime_error
30 };
31         
32
33
34 struct ma_info {
35         char prefix[256];       /* Prefix for a multipart/alternative */
36         int is_ma;              /* Set to 1 if we are using this stuff */
37         int did_print;          /* One alternative has been displayed */
38 };
39
40
41 struct repl {                   /* Info for replication checking */
42         char extended_id[256];
43         time_t highest;
44 };
45
46
47 int alias (char *name);
48 void get_mm (void);
49 void cmd_msgs (char *cmdbuf);
50 void help_subst (char *strbuf, char *source, char *dest);
51 void do_help_subst (char *buffer);
52 void memfmout (int width, char *mptr, char subst, char *nl);
53 void output_mime_parts(char *);
54 void cmd_msg0 (char *cmdbuf);
55 void cmd_msg2 (char *cmdbuf);
56 void cmd_msg3 (char *cmdbuf);
57 void cmd_msg4 (char *cmdbuf);
58 void cmd_opna (char *cmdbuf);
59 long send_message (struct CtdlMessage *, FILE *);
60 void loadtroom (void);
61 long CtdlSaveMsg(struct CtdlMessage *, char *, char *, int);
62 void quickie_message (char *, char *, char *, char *);
63 struct CtdlMessage *make_message (struct usersupp *, char *,
64                    char *, int, int, int, char *);
65 void cmd_ent0 (char *entargs);
66 void cmd_ent3 (char *entargs);
67 void cmd_dele (char *delstr);
68 void cmd_move (char *args);
69 void GetSuppMsgInfo(struct SuppMsgInfo *, long);
70 void PutSuppMsgInfo(struct SuppMsgInfo *);
71 void AdjRefCount(long, int);
72 void simple_listing(long, void *);
73 int CtdlMsgCmp(struct CtdlMessage *msg, struct CtdlMessage *template);
74 int CtdlForEachMessage(int mode, long ref,
75                         int moderation_level,
76                         char *content_type,
77                         struct CtdlMessage *compare,
78                         void (*CallBack) (long, void *),
79                         void *userdata);
80 int CtdlDeleteMessages(char *, long, char *);
81 void CtdlWriteObject(char *, char *, char *, struct usersupp *,
82                         int, int, unsigned int);
83 struct CtdlMessage *CtdlFetchMessage(long msgnum);
84 void CtdlFreeMessage(struct CtdlMessage *msg);
85 void serialize_message(struct ser_ret *, struct CtdlMessage *);
86 int is_valid_message(struct CtdlMessage *);
87 int ReplicationChecks(struct CtdlMessage *);
88 int CtdlSaveMsgPointerInRoom(char *roomname, long msgid, int flags);
89 char *CtdlReadMessageBody(char *terminator, size_t maxlen, char *exist);
90 char *CtdlGetSysConfig(char *sysconfname);
91 void CtdlPutSysConfig(char *sysconfname, char *sysconfdata);
92 int CtdlOutputMsg(long msg_num,         /* message number (local) to fetch */
93                 int mode,               /* how would you like that message? */
94                 int headers_only,       /* eschew the message body? */
95                 int do_proto,           /* do Citadel protocol responses? */
96                 int crlf);
97 int CtdlOutputPreLoadedMsg(struct CtdlMessage *,
98                 long,
99                 int mode,               /* how would you like that message? */
100                 int headers_only,       /* eschew the message body? */
101                 int do_proto,           /* do Citadel protocol responses? */
102                 int crlf);