citadel/msgbase.h

   1
   2 #ifndef MSGBASE_H
   3 #define MSGBASE_H
   4
   5
   6 enum {
   7         MSGS_ALL,
   8         MSGS_OLD,
   9         MSGS_NEW,
  10         MSGS_FIRST,
  11         MSGS_LAST,
  12         MSGS_GT,
  13         MSGS_EQ,
  14         MSGS_SEARCH,
  15         MSGS_LT
  16 };
  17
  18 enum {
  19         MSG_HDRS_BRIEF = 0,
  20         MSG_HDRS_ALL = 1,
  21         MSG_HDRS_EUID = 4
  22 };
  23
  24 /*
  25  * Possible return codes from CtdlOutputMsg()
  26  */
  27 enum {
  28         om_ok,
  29         om_not_logged_in,
  30         om_no_such_msg,
  31         om_mime_error
  32 };
  33
  34 /*
  35  * Values of "headers_only" when calling message output routines
  36  */
  37 #define HEADERS_ALL     0       /* Headers and body */
  38 #define HEADERS_ONLY    1       /* Headers only */
  39 #define HEADERS_NONE    2       /* Body only */
  40 #define HEADERS_FAST    3       /* Headers only with no MIME info */
  41
  42
  43 struct ma_info {
  44         int is_ma;              /* Set to 1 if we are using this stuff */
  45         int freeze;             /* Freeze the replacement chain because we're
  46                                  * digging through a subsection */
  47         int did_print;          /* One alternative has been displayed */
  48         char chosen_part[128];  /* Which part of a m/a did we choose? */
  49         int chosen_pref;        /* Chosen part preference level (lower is better) */
  50         int use_fo_hooks;       /* Use fixed output hooks */
  51 };
  52
  53
  54 struct repl {                   /* Info for replication checking */
  55         char exclusive_id[SIZ];
  56         time_t highest;
  57 };
  58
  59
  60 /* Data structure returned by validate_recipients() */
  61 struct recptypes {
  62         int recptypes_magic;
  63         int num_local;
  64         int num_internet;
  65         int num_ignet;
  66         int num_room;
  67         int num_error;
  68         char *errormsg;
  69         char *recp_local;
  70         char *recp_internet;
  71         char *recp_ignet;
  72         char *recp_room;
  73         char *display_recp;
  74         char *bounce_to;
  75         char *envelope_from;
  76 };
  77
  78 #define RECPTYPES_MAGIC 0xfeeb
  79
  80 /*
  81  * This is a list of "harvested" email addresses that we might want to
  82  * stick into someone's address book.  But we defer this operaiton so
  83  * it can be done asynchronously.
  84  */
  85 struct addresses_to_be_filed {
  86         struct addresses_to_be_filed *next;
  87         char *roomname;
  88         char *collected_addresses;
  89 };
  90
  91 extern struct addresses_to_be_filed *atbf;
  92
  93 int alias (char *name);
  94 void cmd_msgs (char *cmdbuf);
  95 void cmd_isme (char *cmdbuf);
  96 void help_subst (char *strbuf, char *source, char *dest);
  97 void do_help_subst (char *buffer);
  98 void memfmout (char *mptr, const char *nl);
  99 void output_mime_parts(char *);
 100 void cmd_msg0 (char *cmdbuf);
 101 void cmd_msg2 (char *cmdbuf);
 102 void cmd_msg3 (char *cmdbuf);
 103 void cmd_msg4 (char *cmdbuf);
 104 void cmd_msgp (char *cmdbuf);
 105 void cmd_opna (char *cmdbuf);
 106 void cmd_dlat (char *cmdbuf);
 107 long send_message (struct CtdlMessage *);
 108 void loadtroom (void);
 109 long CtdlSubmitMsg(struct CtdlMessage *, struct recptypes *, char *, int);
 110 void quickie_message (const char *, const char *, char *, char *, const char *, int, const char *);
 111 void cmd_ent0 (char *entargs);
 112 void cmd_dele (char *delstr);
 113 void cmd_move (char *args);
 114 void GetMetaData(struct MetaData *, long);
 115 void PutMetaData(struct MetaData *);
 116 void AdjRefCount(long, int);
 117 void TDAP_AdjRefCount(long, int);
 118 int TDAP_ProcessAdjRefCountQueue(void);
 119 void simple_listing(long, void *);
 120 int CtdlMsgCmp(struct CtdlMessage *msg, struct CtdlMessage *template);
 121 typedef void (*ForEachMsgCallback)(long MsgNumber, void *UserData);
 122 int CtdlForEachMessage(int mode,
 123                         long ref,
 124                         char *searchstring,
 125                         char *content_type,
 126                         struct CtdlMessage *compare,
 127                         ForEachMsgCallback CallBack,
 128                         void *userdata);
 129 int CtdlDeleteMessages(char *, long *, int, char *);
 130 void CtdlWriteObject(char *req_room,                    /* Room to stuff it in */
 131                         char *content_type,             /* MIME type of this object */
 132                         char *raw_message,              /* Data to be written */
 133                         off_t raw_length,               /* Size of raw_message */
 134                         struct ctdluser *is_mailbox,    /* Mailbox room? */
 135                         int is_binary,                  /* Is encoding necessary? */
 136                         int is_unique,                  /* Del others of this type? */
 137                         unsigned int flags              /* Internal save flags */
 138 );
 139 struct CtdlMessage *CtdlFetchMessage(long msgnum, int with_body);
 140 void CtdlFreeMessage(struct CtdlMessage *msg);
 141 void serialize_message(struct ser_ret *, struct CtdlMessage *);
 142 void dump_message(struct CtdlMessage *msg, long Siz);
 143 int is_valid_message(struct CtdlMessage *);
 144 void ReplicationChecks(struct CtdlMessage *);
 145 int CtdlSaveMsgPointersInRoom(char *roomname, long newmsgidlist[], int num_newmsgs,
 146                         int do_repl_check, struct CtdlMessage *supplied_msg, int suppress_refcount_adj);
 147 int CtdlSaveMsgPointerInRoom(char *roomname, long msgid, int do_repl_check, struct CtdlMessage *msg);
 148 char *CtdlReadMessageBody(char *terminator, long tlen, size_t maxlen, char *exist, int crlf, int *sock);
 149 StrBuf *CtdlReadMessageBodyBuf(char *terminator,        /* token signalling EOT */
 150                                long tlen,
 151                                size_t maxlen,           /* maximum message length */
 152                                char *exist,             /* if non-null, append to it;
 153                                                            exist is ALWAYS freed  */
 154                                int crlf,                /* CRLF newlines instead of LF */
 155                                int *sock                /* socket handle or 0 for this session's client socket */
 156         );
 157
 158 int CtdlOutputMsg(long msg_num,         /* message number (local) to fetch */
 159                   int mode,             /* how would you like that message? */
 160                   int headers_only,     /* eschew the message body? */
 161                   int do_proto,         /* do Citadel protocol responses? */
 162                   int crlf,             /* 0=LF, 1=CRLF */
 163                   char *section,                /* output a message/rfc822 section */
 164                   int flags             /* should the bessage be exported clean? */
 165 );
 166
 167 /* Flags which may be passed to CtdlOutputMsg() and CtdlOutputPreLoadedMsg() */
 168 #define QP_EADDR        (1<<0)          /* quoted-printable encode email addresses */
 169 #define CRLF            (1<<1)
 170 #define ESC_DOT         (1<<2)          /* output a line containing only "." as ".." instead */
 171 #define SUPPRESS_ENV_TO (1<<3)          /* suppress Envelope-to: header (warning: destructive!) */
 172
 173 int CtdlOutputPreLoadedMsg(struct CtdlMessage *,
 174                            int mode,            /* how would you like that message? */
 175                            int headers_only,    /* eschew the message body? */
 176                            int do_proto,        /* do Citadel protocol responses? */
 177                            int crlf,            /* 0=LF, 1=CRLF */
 178                            int flags            /* should the bessage be exported clean? */
 179 );
 180 int CtdlDoIHavePermissionToDeleteMessagesFromThisRoom(void);
 181 int CtdlDoIHavePermissionToReadMessagesInThisRoom(void);
 182
 183 enum {
 184         POST_LOGGED_IN,
 185         POST_EXTERNAL,
 186         CHECK_EXISTANCE,
 187         POST_LMTP
 188 };
 189
 190 int CtdlDoIHavePermissionToPostInThisRoom(char *errmsgbuf,
 191         size_t n,
 192         const char* RemoteIdentifier,
 193         int PostPublic,
 194         int is_reply
 195 );
 196
 197
 198 /* values for which_set */
 199 enum {
 200         ctdlsetseen_seen,
 201         ctdlsetseen_answered
 202 };
 203 void CtdlSetSeen(long *target_msgnums, int num_target_msgnums,
 204                  int target_setting, int which_set,
 205                 struct ctdluser *which_user, struct ctdlroom *which_room);
 206 void CtdlGetSeen(char *buf, int which_set);
 207
 208 struct recptypes *validate_recipients(const char *recipients,
 209                                       const char *RemoteIdentifier,
 210                                       int Flags);
 211
 212 void free_recipients(struct recptypes *);
 213
 214 struct CtdlMessage *CtdlMakeMessage(
 215         struct ctdluser *author,        /* author's user structure */
 216         char *recipient,                /* NULL if it's not mail */
 217         char *recp_cc,                  /* NULL if it's not mail */
 218         char *room,                     /* room where it's going */
 219         int type,                       /* see MES_ types in header file */
 220         int format_type,                /* variformat, plain text, MIME... */
 221         char *fake_name,                /* who we're masquerading as */
 222         char *my_email,                 /* which of my email addresses to use (empty is ok) */
 223         char *subject,                  /* Subject (optional) */
 224         char *supplied_euid,            /* ...or NULL if this is irrelevant */
 225         char *preformatted_text,        /* ...or NULL to read text from client */
 226         char *references                /* Thread references */
 227 );
 228 int CtdlCheckInternetMailPermission(struct ctdluser *who);
 229 int CtdlIsMe(char *addr, int addr_buf_len);
 230
 231 /*
 232  * Use of aide_message is deprecated.
 233  * It has been replaced with CtdlAideMessage.
 234  * All parameters remain the same.
 235 */
 236 void aide_message(char *text, char *subject) __attribute__ ((deprecated));
 237
 238
 239
 240 #endif /* MSGBASE_H */