citadel/citadel_ipc.h

   1 /* $Id$ */
   2
   3 struct ctdlipcroom {
   4         char RRname[ROOMNAMELEN];       /* Name of room */
   5         long RRunread;                  /* Number of unread messages */
   6         long RRtotal;                   /* Total number of messages in room */
   7         char RRinfoupdated;             /* Nonzero if info was updated */
   8         unsigned RRflags;               /* Various flags (see LKRN) */
   9         long RRhighest;                 /* Highest message number in room */
  10         long RRlastread;                /* Highest message user has read */
  11         char RRismailbox;               /* Is this room a mailbox room? */
  12         char RRaide;                    /* User can do aide commands in room */
  13         long RRnewmail;                 /* Number of new mail messages */
  14         char RRfloor;                   /* Which floor this room is on */
  15 };
  16
  17
  18 struct parts {
  19         struct parts *next;
  20         char number[16];                /* part number */
  21         char name[PATH_MAX];            /* Name */
  22         char filename[PATH_MAX];        /* Suggested filename */
  23         char mimetype[SIZ];             /* MIME type */
  24         char disposition[SIZ];          /* Content disposition */
  25         unsigned long length;           /* Content length */
  26 };
  27
  28
  29 struct ctdlipcmessage {
  30         char msgid[SIZ];                /* Original message ID */
  31         char path[SIZ];                 /* Return path to sender */
  32         char zaps[SIZ];                 /* Message ID that this supersedes */
  33         char subject[SIZ];              /* Message subject */
  34         char email[SIZ];                /* Email address of sender */
  35         char author[USERNAME_SIZE];     /* Sender of message */
  36         char recipient[USERNAME_SIZE];  /* Recipient of message */
  37         char room[ROOMNAMELEN];         /* Originating room */
  38         char node[16];                  /* Short nodename of origin system */
  39         char hnod[21];                  /* Humannode of origin system */
  40         struct parts *attachments;      /* Available attachments */
  41         char *text;                     /* Message text */
  42         int type;                       /* Message type */
  43         time_t time;                    /* Time message was posted */
  44         char nhdr;                      /* Suppress message header? */
  45         char anonymous;                 /* An anonymous message */
  46 };
  47
  48
  49 struct ctdlipcmisc {
  50         long newmail;                   /* Number of new Mail messages */
  51         char needregis;                 /* Nonzero if user needs to register */
  52         char needvalid;                 /* Nonzero if users need validation */
  53 };
  54
  55 #ifdef __cplusplus
  56 extern "C" {
  57 #endif
  58
  59 int CtdlIPCNoop(void);
  60 int CtdlIPCEcho(const char *arg, char *cret);
  61 int CtdlIPCQuit(void);
  62 int CtdlIPCLogout(void);
  63 int CtdlIPCTryLogin(const char *username, char *cret);
  64 int CtdlIPCTryPassword(const char *passwd, char *cret);
  65 int CtdlIPCCreateUser(const char *username, int selfservice, char *cret);
  66 int CtdlIPCChangePassword(const char *passwd, char *cret);
  67 int CtdlIPCKnownRooms(int which, int floor, struct march **listing, char *cret);
  68 int CtdlIPCGetConfig(struct usersupp **uret, char *cret);
  69 int CtdlIPCSetConfig(struct usersupp *uret, char *cret);
  70 int CtdlIPCGotoRoom(const char *room, const char *passwd,
  71                 struct ctdlipcroom **rret, char *cret);
  72 int CtdlIPCGetMessages(int which, int whicharg, const char *template,
  73                 long **mret, char *cret);
  74 int CtdlIPCGetSingleMessage(long msgnum, int headers, int as_mime,
  75                 struct ctdlipcmessage **mret, char *cret);
  76 int CtdlIPCWhoKnowsRoom(char **listing, char *cret);
  77 int CtdlIPCServerInfo(struct CtdlServInfo *ServInfo, char *cret);
  78 int CtdlIPCReadDirectory(char **listing, char *cret);
  79 int CtdlIPCSetLastRead(long msgnum, char *cret);
  80 int CtdlIPCInviteUserToRoom(const char *username, char *cret);
  81 int CtdlIPCKickoutUserFromRoom(const char *username, char *cret);
  82 int CtdlIPCGetRoomAttributes(struct quickroom **qret, char *cret);
  83 int CtdlIPCSetRoomAttributes(int forget, struct quickroom *qret, char *cret);
  84 int CtdlIPCGetRoomAide(char *cret);
  85 int CtdlIPCSetRoomAide(const char *username, char *cret);
  86 int CtdlIPCPostMessage(int flag, const struct ctdlipcmessage *mr, char *cret);
  87 int CtdlIPCRoomInfo(char **iret, char *cret);
  88 int CtdlIPCDeleteMessage(long msgnum, char *cret);
  89 int CtdlIPCMoveMessage(int copy, long msgnum, const char *destroom, char *cret);
  90 int CtdlIPCDeleteRoom(int for_real, char *cret);
  91 int CtdlIPCCreateRoom(int for_real, const char *roomname, int type,
  92                 const char *password, int floor, char *cret);
  93 int CtdlIPCForgetRoom(char *cret);
  94 int CtdlIPCSystemMessage(const char *message, char **mret, char *cret);
  95 int CtdlIPCNextUnvalidatedUser(char *cret);
  96 int CtdlIPCGetUserRegistration(const char *username, char **rret, char *cret);
  97 int CtdlIPCValidateUser(const char *username, int axlevel, char *cret);
  98 int CtdlIPCSetRoomInfo(int for_real, const char *info, char *cret);
  99 int CtdlIPCUserListing(char **list, char *cret);
 100 int CtdlIPCSetRegistration(const char *info, char *cret);
 101 int CtdlIPCMiscCheck(struct ctdlipcmisc *chek, char *cret);
 102 int CtdlIPCDeleteFile(const char *filename, char *cret);
 103 int CtdlIPCMoveFile(const char *filename, const char *destroom, char *cret);
 104 int CtdlIPCNetSendFile(const char *filename, const char *destnode, char *cret);
 105 int CtdlIPCOnlineUsers(char **listing, time_t *stamp, char *cret);
 106 int CtdlIPCFileDownload(const char *filename, void **buf, char *cret);
 107 int CtdlIPCAttachmentDownload(long msgnum, const char *part, void **buf,
 108                 char *cret);
 109 int CtdlIPCImageDownload(const char *filename, void **buf, char *cret);
 110 int CtdlIPCFileUpload(const char *filename, const char *comment, void *buf,
 111                 size_t bytes, char *cret);
 112 int CtdlIPCImageUpload(int for_real, const char *filename, size_t bytes,
 113                 char *cret);
 114 int CtdlIPCQueryUsername(const char *username, char *cret);
 115 int CtdlIPCFloorListing(char **listing, char *cret);
 116 int CtdlIPCCreateFloor(int for_real, const char *name, char *cret);
 117 int CtdlIPCDeleteFloor(int for_real, int floornum, char *cret);
 118 int CtdlIPCEditFloor(int floornum, const char *floorname, char *cret);
 119 int CtdlIPCIdentifySoftware(int developerid, int clientid, int revision,
 120                 const char *software_name, const char *hostname, char *cret);
 121 int CtdlIPCSendInstantMessage(const char *username, const char *text,
 122                 char *cret);
 123 int CtdlIPCGetInstantMessage(char **listing, char *cret);
 124 int CtdlIPCEnableInstantMessageReceipt(int mode, char *cret);
 125 int CtdlIPCSetBio(char *bio, char *cret);
 126 int CtdlIPCGetBio(const char *username, char **listing, char *cret);
 127 int CtdlIPCListUsersWithBios(char **listing, char *cret);
 128 int CtdlIPCStealthMode(int mode, char *cret);
 129 int CtdlIPCTerminateSession(int sid, char *cret);
 130 int CtdlIPCTerminateServerNow(char *cret);
 131 int CtdlIPCTerminateServerScheduled(int mode, char *cret);
 132 int CtdlIPCEnterSystemMessage(const char *filename, const char *text,
 133                 char *cret);
 134 int CtdlIPCChangeHostname(const char *hostname, char *cret);
 135 int CtdlIPCChangeRoomname(const char *roomname, char *cret);
 136 int CtdlIPCChangeUsername(const char *username, char *cret);
 137 time_t CtdlIPCServerTime(char *crert);
 138 int CtdlIPCAideGetUserParameters(const char *who,
 139                                  struct usersupp **uret, char *cret);
 140 int CtdlIPCAideSetUserParameters(const struct usersupp *uret, char *cret);
 141 int CtdlIPCGetMessageExpirationPolicy(int which, char *cret);
 142 int CtdlIPCSetMessageExpirationPolicy(int which, int policy, int value,
 143                 char *cret);
 144 int CtdlGetSystemConfig(char **listing, char *cret);
 145 int CtdlSetSystemConfig(const char *listing, char *cret);
 146 int CtdlIPCModerateMessage(long msgnum, int level, char *cret);
 147 int CtdlIPCRequestClientLogout(int session, char *cret);
 148 int CtdlIPCSetMessageSeen(long msgnum, int seen, char *cret);
 149 int CtdlIPCStartEncryption(char *cret);
 150 int CtdlIPCDirectoryLookup(const char *address, char *cret);
 151
 152 /* ************************************************************************** */
 153 /*             Stuff below this line is not for public consumption            */
 154 /* ************************************************************************** */
 155
 156 inline void netio_lock(void);
 157 inline void netio_unlock(void);
 158 char *CtdlIPCReadListing(char *dest);
 159 int CtdlIPCSendListing(const char *listing);
 160 size_t CtdlIPCPartialRead(void **buf, size_t offset, size_t bytes, char *cret);
 161 int CtdlIPCEndUpload(char *cret);
 162 int CtdlIPCWriteUpload(void *buf, size_t bytes, char *cret);
 163 int CtdlIPCEndDownload(char *cret);
 164 int CtdlIPCReadDownload(void **buf, size_t bytes, char *cret);
 165 int CtdlIPCGenericCommand(const char *command, const char *to_send,
 166                 size_t bytes_to_send, char **to_receive,
 167                 size_t *bytes_to_receive, char *proto_response);
 168
 169 #ifdef __cplusplus
 170 }
 171 #endif