1d1874e45754c2e0fdec3b152c6809f2952dce9a
[citadel] / citadel / msgbase.h
1 /* $Id$ */
2
3 #define aide_message(text)      quickie_message("Citadel",NULL,AIDEROOM,text,0,NULL)
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  * Values of "headers_only" when calling message output routines
34  */
35 #define HEADERS_ALL     0       /* Headers and body */
36 #define HEADERS_ONLY    1       /* Headers only */
37 #define HEADERS_NONE    2       /* Body only */
38 #define HEADERS_FAST    3       /* Headers only with no MIME info */
39
40
41 struct ma_info {
42         int is_ma;              /* Set to 1 if we are using this stuff */
43         int did_print;          /* One alternative has been displayed */
44         char chosen_part[SIZ];  /* Which part of a m/a did we choose? */
45 };
46
47
48 struct repl {                   /* Info for replication checking */
49         char extended_id[SIZ];
50         time_t highest;
51 };
52
53
54 /* Data structure returned by validate_recipients() */
55 struct recptypes {
56         int num_local;
57         int num_internet;
58         int num_ignet;
59         int num_room;
60         int num_error;
61         char errormsg[SIZ];
62         char recp_local[SIZ];
63         char recp_internet[SIZ];
64         char recp_ignet[SIZ];
65         char recp_room[SIZ];
66         char display_recp[SIZ];
67 };
68
69
70
71 int alias (char *name);
72 void get_mm (void);
73 void cmd_msgs (char *cmdbuf);
74 void cmd_isme (char *cmdbuf);
75 void help_subst (char *strbuf, char *source, char *dest);
76 void do_help_subst (char *buffer);
77 void memfmout (int width, char *mptr, char subst, char *nl);
78 void output_mime_parts(char *);
79 void cmd_msg0 (char *cmdbuf);
80 void cmd_msg2 (char *cmdbuf);
81 void cmd_msg3 (char *cmdbuf);
82 void cmd_msg4 (char *cmdbuf);
83 void cmd_msgp (char *cmdbuf);
84 void cmd_opna (char *cmdbuf);
85 long send_message (struct CtdlMessage *, FILE *);
86 void loadtroom (void);
87 long CtdlSubmitMsg(struct CtdlMessage *, struct recptypes *, char *);
88 void quickie_message (char *, char *, char *, char *, int, char *);
89 void cmd_ent0 (char *entargs);
90 void cmd_dele (char *delstr);
91 void cmd_move (char *args);
92 void GetMetaData(struct MetaData *, long);
93 void PutMetaData(struct MetaData *);
94 void AdjRefCount(long, int);
95 void simple_listing(long, void *);
96 int CtdlMsgCmp(struct CtdlMessage *msg, struct CtdlMessage *template);
97 int CtdlForEachMessage(int mode, long ref,
98                         char *content_type,
99                         struct CtdlMessage *compare,
100                         void (*CallBack) (long, void *),
101                         void *userdata);
102 int CtdlDeleteMessages(char *, long, char *);
103 void CtdlWriteObject(char *, char *, char *, struct ctdluser *,
104                         int, int, unsigned int);
105 struct CtdlMessage *CtdlFetchMessage(long msgnum);
106 void CtdlFreeMessage(struct CtdlMessage *msg);
107 void serialize_message(struct ser_ret *, struct CtdlMessage *);
108 int is_valid_message(struct CtdlMessage *);
109 int ReplicationChecks(struct CtdlMessage *);
110 int CtdlSaveMsgPointerInRoom(char *roomname, long msgid, int flags);
111 char *CtdlReadMessageBody(char *terminator, size_t maxlen, char *exist, int crlf);
112 char *CtdlGetSysConfig(char *sysconfname);
113 void CtdlPutSysConfig(char *sysconfname, char *sysconfdata);
114 int CtdlOutputMsg(long msg_num,         /* message number (local) to fetch */
115                 int mode,               /* how would you like that message? */
116                 int headers_only,       /* eschew the message body? */
117                 int do_proto,           /* do Citadel protocol responses? */
118                 int crlf);
119 int CtdlOutputPreLoadedMsg(struct CtdlMessage *,
120                 long,
121                 int mode,               /* how would you like that message? */
122                 int headers_only,       /* eschew the message body? */
123                 int do_proto,           /* do Citadel protocol responses? */
124                 int crlf);
125 int CtdlCopyMsgToRoom(long msgnum, char *dest);
126 int CtdlDoIHavePermissionToDeleteMessagesFromThisRoom(void);
127 int CtdlDoIHavePermissionToPostInThisRoom(char *errmsgbuf, size_t n);
128
129
130 /* values for which_set */
131 enum {
132         ctdlsetseen_seen,
133         ctdlsetseen_answered
134 };
135 void CtdlSetSeen(long target_msgnum, int target_setting, int which_set);
136 void CtdlGetSeen(char *buf, int which_set);
137
138 struct recptypes *validate_recipients(char *recipients);
139 struct CtdlMessage *CtdlMakeMessage(
140         struct ctdluser *author,        /* author's user structure */
141         char *recipient,                /* NULL if it's not mail */
142         char *room,                     /* room where it's going */
143         int type,                       /* see MES_ types in header file */
144         int format_type,                /* variformat, plain text, MIME... */
145         char *fake_name,                /* who we're masquerading as */
146         char *subject,                  /* Subject (optional) */
147         char *preformatted_text         /* ...or NULL to read text from client */
148 );
149 int CtdlCheckInternetMailPermission(struct ctdluser *who);
150 int CtdlIsMe(char *addr);