citadel/msgbase.h

   1 /* $Id$ */
   2
   3 #define aide_message(text)      quickie_message("Citadel",NULL,AIDEROOM,text)
   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
  34 struct ma_info {
  35         int is_ma;              /* Set to 1 if we are using this stuff */
  36         int did_print;          /* One alternative has been displayed */
  37 };
  38
  39
  40 struct repl {                   /* Info for replication checking */
  41         char extended_id[SIZ];
  42         time_t highest;
  43 };
  44
  45
  46 /* Data structure returned by validate_recipients() */
  47 struct recptypes {
  48         int num_local;
  49         int num_internet;
  50         int num_ignet;
  51         int num_error;
  52         char errormsg[SIZ];
  53         char recp_local[SIZ];
  54         char recp_internet[SIZ];
  55         char recp_ignet[SIZ];
  56         char display_recp[SIZ];
  57 };
  58
  59
  60
  61 int alias (char *name);
  62 void get_mm (void);
  63 void cmd_msgs (char *cmdbuf);
  64 void help_subst (char *strbuf, char *source, char *dest);
  65 void do_help_subst (char *buffer);
  66 void memfmout (int width, char *mptr, char subst, char *nl);
  67 void output_mime_parts(char *);
  68 void cmd_msg0 (char *cmdbuf);
  69 void cmd_msg2 (char *cmdbuf);
  70 void cmd_msg3 (char *cmdbuf);
  71 void cmd_msg4 (char *cmdbuf);
  72 void cmd_opna (char *cmdbuf);
  73 long send_message (struct CtdlMessage *, FILE *);
  74 void loadtroom (void);
  75 long CtdlSubmitMsg(struct CtdlMessage *, struct recptypes *, char *);
  76 void quickie_message (char *, char *, char *, char *);
  77 void cmd_ent0 (char *entargs);
  78 void cmd_dele (char *delstr);
  79 void cmd_move (char *args);
  80 void GetMetaData(struct MetaData *, long);
  81 void PutMetaData(struct MetaData *);
  82 void AdjRefCount(long, int);
  83 void simple_listing(long, void *);
  84 int CtdlMsgCmp(struct CtdlMessage *msg, struct CtdlMessage *template);
  85 int CtdlForEachMessage(int mode, long ref,
  86                         int moderation_level,
  87                         char *content_type,
  88                         struct CtdlMessage *compare,
  89                         void (*CallBack) (long, void *),
  90                         void *userdata);
  91 int CtdlDeleteMessages(char *, long, char *);
  92 void CtdlWriteObject(char *, char *, char *, struct usersupp *,
  93                         int, int, unsigned int);
  94 struct CtdlMessage *CtdlFetchMessage(long msgnum);
  95 void CtdlFreeMessage(struct CtdlMessage *msg);
  96 void serialize_message(struct ser_ret *, struct CtdlMessage *);
  97 int is_valid_message(struct CtdlMessage *);
  98 int ReplicationChecks(struct CtdlMessage *);
  99 int CtdlSaveMsgPointerInRoom(char *roomname, long msgid, int flags);
 100 char *CtdlReadMessageBody(char *terminator, size_t maxlen, char *exist);
 101 char *CtdlGetSysConfig(char *sysconfname);
 102 void CtdlPutSysConfig(char *sysconfname, char *sysconfdata);
 103 int CtdlOutputMsg(long msg_num,         /* message number (local) to fetch */
 104                 int mode,               /* how would you like that message? */
 105                 int headers_only,       /* eschew the message body? */
 106                 int do_proto,           /* do Citadel protocol responses? */
 107                 int crlf);
 108 int CtdlOutputPreLoadedMsg(struct CtdlMessage *,
 109                 long,
 110                 int mode,               /* how would you like that message? */
 111                 int headers_only,       /* eschew the message body? */
 112                 int do_proto,           /* do Citadel protocol responses? */
 113                 int crlf);
 114 int CtdlCopyMsgToRoom(long msgnum, char *dest);
 115 int CtdlDoIHavePermissionToDeleteMessagesFromThisRoom(void);
 116 int CtdlDoIHavePermissionToPostInThisRoom(char *errmsgbuf);
 117 void CtdlSetSeen(long target_msgnum, int target_setting);