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 exclusive_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  * This is a list of "harvested" email addresses that we might want to
  71  * stick into someone's address book.  But we defer this operaiton so
  72  * it can be done asynchronously.
  73  */
  74 struct addresses_to_be_filed {
  75         struct addresses_to_be_filed *next;
  76         char *roomname;
  77         char *collected_addresses;
  78 };
  79
  80 extern struct addresses_to_be_filed *atbf;
  81
  82 int alias (char *name);
  83 void get_mm (void);
  84 void cmd_msgs (char *cmdbuf);
  85 void cmd_isme (char *cmdbuf);
  86 void help_subst (char *strbuf, char *source, char *dest);
  87 void do_help_subst (char *buffer);
  88 void memfmout (int width, char *mptr, char subst, char *nl);
  89 void output_mime_parts(char *);
  90 void cmd_msg0 (char *cmdbuf);
  91 void cmd_msg2 (char *cmdbuf);
  92 void cmd_msg3 (char *cmdbuf);
  93 void cmd_msg4 (char *cmdbuf);
  94 void cmd_msgp (char *cmdbuf);
  95 void cmd_opna (char *cmdbuf);
  96 long send_message (struct CtdlMessage *);
  97 void loadtroom (void);
  98 long CtdlSubmitMsg(struct CtdlMessage *, struct recptypes *, char *);
  99 void quickie_message (char *, char *, char *, char *, int, char *);
 100 void cmd_ent0 (char *entargs);
 101 void cmd_dele (char *delstr);
 102 void cmd_move (char *args);
 103 void GetMetaData(struct MetaData *, long);
 104 void PutMetaData(struct MetaData *);
 105 void AdjRefCount(long, int);
 106 void simple_listing(long, void *);
 107 int CtdlMsgCmp(struct CtdlMessage *msg, struct CtdlMessage *template);
 108 int CtdlForEachMessage(int mode, long ref,
 109                         char *content_type,
 110                         struct CtdlMessage *compare,
 111                         void (*CallBack) (long, void *),
 112                         void *userdata);
 113 int CtdlDeleteMessages(char *, long, char *, int);
 114 void CtdlWriteObject(char *, char *, char *, struct ctdluser *,
 115                         int, int, unsigned int);
 116 struct CtdlMessage *CtdlFetchMessage(long msgnum, int with_body);
 117 void CtdlFreeMessage(struct CtdlMessage *msg);
 118 void serialize_message(struct ser_ret *, struct CtdlMessage *);
 119 int is_valid_message(struct CtdlMessage *);
 120 int ReplicationChecks(struct CtdlMessage *);
 121 int CtdlSaveMsgPointerInRoom(char *roomname, long msgid, int flags);
 122 char *CtdlReadMessageBody(char *terminator, size_t maxlen, char *exist, int crlf);
 123 char *CtdlGetSysConfig(char *sysconfname);
 124 void CtdlPutSysConfig(char *sysconfname, char *sysconfdata);
 125 int CtdlOutputMsg(long msg_num,         /* message number (local) to fetch */
 126                 int mode,               /* how would you like that message? */
 127                 int headers_only,       /* eschew the message body? */
 128                 int do_proto,           /* do Citadel protocol responses? */
 129                 int crlf);
 130 int CtdlOutputPreLoadedMsg(struct CtdlMessage *,
 131                 long,
 132                 int mode,               /* how would you like that message? */
 133                 int headers_only,       /* eschew the message body? */
 134                 int do_proto,           /* do Citadel protocol responses? */
 135                 int crlf);
 136 int CtdlCopyMsgToRoom(long msgnum, char *dest);
 137 int CtdlDoIHavePermissionToDeleteMessagesFromThisRoom(void);
 138 int CtdlDoIHavePermissionToPostInThisRoom(char *errmsgbuf, size_t n);
 139
 140
 141 /* values for which_set */
 142 enum {
 143         ctdlsetseen_seen,
 144         ctdlsetseen_answered
 145 };
 146 void CtdlSetSeen(long target_msgnum, int target_setting, int which_set,
 147                 struct ctdluser *which_user, struct ctdlroom *which_room);
 148 void CtdlGetSeen(char *buf, int which_set);
 149
 150 struct recptypes *validate_recipients(char *recipients);
 151 struct CtdlMessage *CtdlMakeMessage(
 152         struct ctdluser *author,        /* author's user structure */
 153         char *recipient,                /* NULL if it's not mail */
 154         char *recp_cc,                  /* NULL if it's not mail */
 155         char *room,                     /* room where it's going */
 156         int type,                       /* see MES_ types in header file */
 157         int format_type,                /* variformat, plain text, MIME... */
 158         char *fake_name,                /* who we're masquerading as */
 159         char *subject,                  /* Subject (optional) */
 160         char *preformatted_text         /* ...or NULL to read text from client */
 161 );
 162 int CtdlCheckInternetMailPermission(struct ctdluser *who);
 163 int CtdlIsMe(char *addr, int addr_buf_len);