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  * Possible return codes from CtdlOutputMsg()
  15  */
  16 enum {
  17         om_ok,
  18         om_not_logged_in,
  19         om_no_such_msg,
  20         om_mime_error
  21 };
  22
  23 /*
  24  * Values of "headers_only" when calling message output routines
  25  */
  26 #define HEADERS_ALL     0       /* Headers and body */
  27 #define HEADERS_ONLY    1       /* Headers only */
  28 #define HEADERS_NONE    2       /* Body only */
  29 #define HEADERS_FAST    3       /* Headers only with no MIME info */
  30
  31
  32 struct ma_info {
  33         int is_ma;              /* Set to 1 if we are using this stuff */
  34         int did_print;          /* One alternative has been displayed */
  35         char chosen_part[128];  /* Which part of a m/a did we choose? */
  36 };
  37
  38
  39 struct repl {                   /* Info for replication checking */
  40         char exclusive_id[SIZ];
  41         time_t highest;
  42 };
  43
  44
  45 /* Data structure returned by validate_recipients() */
  46 struct recptypes {
  47         int num_local;
  48         int num_internet;
  49         int num_ignet;
  50         int num_room;
  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 recp_room[SIZ];
  57         char display_recp[SIZ];
  58 };
  59
  60 /*
  61  * This is a list of "harvested" email addresses that we might want to
  62  * stick into someone's address book.  But we defer this operaiton so
  63  * it can be done asynchronously.
  64  */
  65 struct addresses_to_be_filed {
  66         struct addresses_to_be_filed *next;
  67         char *roomname;
  68         char *collected_addresses;
  69 };
  70
  71 extern struct addresses_to_be_filed *atbf;
  72
  73 int alias (char *name);
  74 void get_mm (void);
  75 void cmd_msgs (char *cmdbuf);
  76 void cmd_isme (char *cmdbuf);
  77 void help_subst (char *strbuf, char *source, char *dest);
  78 void do_help_subst (char *buffer);
  79 void memfmout (int width, char *mptr, char subst, char *nl);
  80 void output_mime_parts(char *);
  81 void cmd_msg0 (char *cmdbuf);
  82 void cmd_msg2 (char *cmdbuf);
  83 void cmd_msg3 (char *cmdbuf);
  84 void cmd_msg4 (char *cmdbuf);
  85 void cmd_msgp (char *cmdbuf);
  86 void cmd_opna (char *cmdbuf);
  87 long send_message (struct CtdlMessage *);
  88 void loadtroom (void);
  89 long CtdlSubmitMsg(struct CtdlMessage *, struct recptypes *, char *);
  90 void quickie_message (char *, char *, char *, char *, int, char *);
  91 void cmd_ent0 (char *entargs);
  92 void cmd_dele (char *delstr);
  93 void cmd_move (char *args);
  94 void GetMetaData(struct MetaData *, long);
  95 void PutMetaData(struct MetaData *);
  96 void AdjRefCount(long, int);
  97 void simple_listing(long, void *);
  98 int CtdlMsgCmp(struct CtdlMessage *msg, struct CtdlMessage *template);
  99 int CtdlForEachMessage(int mode, long ref,
 100                         char *content_type,
 101                         struct CtdlMessage *compare,
 102                         void (*CallBack) (long, void *),
 103                         void *userdata);
 104 int CtdlDeleteMessages(char *, long, char *, int);
 105 void CtdlWriteObject(char *, char *, char *, struct ctdluser *,
 106                         int, int, unsigned int);
 107 struct CtdlMessage *CtdlFetchMessage(long msgnum, int with_body);
 108 void CtdlFreeMessage(struct CtdlMessage *msg);
 109 void serialize_message(struct ser_ret *, struct CtdlMessage *);
 110 int is_valid_message(struct CtdlMessage *);
 111 void ReplicationChecks(struct CtdlMessage *);
 112 int CtdlSaveMsgPointerInRoom(char *roomname, long msgid, int do_repl_check, struct CtdlMessage *msg);
 113 char *CtdlReadMessageBody(char *terminator, size_t maxlen, char *exist, int crlf);
 114 char *CtdlGetSysConfig(char *sysconfname);
 115 void CtdlPutSysConfig(char *sysconfname, char *sysconfdata);
 116 int CtdlOutputMsg(long msg_num,         /* message number (local) to fetch */
 117                 int mode,               /* how would you like that message? */
 118                 int headers_only,       /* eschew the message body? */
 119                 int do_proto,           /* do Citadel protocol responses? */
 120                 int crlf,               /* 0=LF, 1=CRLF */
 121                 char *section           /* output a message/rfc822 section */
 122 );
 123 int CtdlOutputPreLoadedMsg(struct CtdlMessage *,
 124                 int mode,               /* how would you like that message? */
 125                 int headers_only,       /* eschew the message body? */
 126                 int do_proto,           /* do Citadel protocol responses? */
 127                 int crlf                /* 0=LF, 1=CRLF */
 128 );
 129 int CtdlCopyMsgToRoom(long msgnum, char *dest);
 130 int CtdlDoIHavePermissionToDeleteMessagesFromThisRoom(void);
 131 int CtdlDoIHavePermissionToPostInThisRoom(char *errmsgbuf, size_t n);
 132
 133
 134 /* values for which_set */
 135 enum {
 136         ctdlsetseen_seen,
 137         ctdlsetseen_answered
 138 };
 139 void CtdlSetSeen(long *target_msgnums, int num_target_msgnums,
 140                  int target_setting, int which_set,
 141                 struct ctdluser *which_user, struct ctdlroom *which_room);
 142 void CtdlGetSeen(char *buf, int which_set);
 143
 144 struct recptypes *validate_recipients(char *recipients);
 145 struct CtdlMessage *CtdlMakeMessage(
 146         struct ctdluser *author,        /* author's user structure */
 147         char *recipient,                /* NULL if it's not mail */
 148         char *recp_cc,                  /* NULL if it's not mail */
 149         char *room,                     /* room where it's going */
 150         int type,                       /* see MES_ types in header file */
 151         int format_type,                /* variformat, plain text, MIME... */
 152         char *fake_name,                /* who we're masquerading as */
 153         char *subject,                  /* Subject (optional) */
 154         char *preformatted_text         /* ...or NULL to read text from client */
 155 );
 156 int CtdlCheckInternetMailPermission(struct ctdluser *who);
 157 int CtdlIsMe(char *addr, int addr_buf_len);