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