citadel/msgbase.h

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