* Renamed "struct user" to "struct ctdluser"
[citadel.git] / citadel / citadel_ipc.h
index 81c941297c5619c21ffdeab8d8833ee83178e98f..df0f90e9817c50bfdfa078bfbdd457fc9c2821c3 100644 (file)
@@ -1,5 +1,63 @@
 /* $Id$ */
 
+#include "sysdep.h"
+#ifdef HAVE_PTHREAD_H
+#include <pthread.h>
+#endif
+#ifdef HAVE_OPENSSL
+#include <openssl/ssl.h>
+#include <openssl/err.h>
+#include <openssl/rand.h>
+#endif
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/* Quick and dirty hack; we don't want to use malloc() in C++ */
+#ifdef __cplusplus
+#define ialloc(t)      new t()
+#define ifree(o)       delete o
+#else
+#define ialloc(t)      malloc(sizeof(t))
+#define ifree(o)       free(o);
+#endif
+
+/* This class is responsible for the server connection */
+typedef struct _CtdlIPC {
+#if defined(HAVE_OPENSSL)
+       /* NULL if not encrypted, non-NULL otherwise */
+       SSL *ssl;
+#endif
+#if defined(HAVE_PTHREAD_H)
+       /* Fast mutex, call CtdlIPC_lock() or CtdlIPC_unlock() to use */
+       pthread_mutex_t mutex;
+#endif
+       /* -1 if not connected, >= 0 otherwise */
+       int sock;
+       /* 1 if server is local, 0 otherwise or if not connected */
+       int isLocal;
+       /* 1 if a download is open on the server, 0 otherwise */
+       int downloading;
+       /* 1 if an upload is open on the server, 0 otherwise */
+       int uploading;
+       /* Time the last command was sent to the server */
+       time_t last_command_sent;
+       /* Callback for update on whether the IPC is locked */
+       void (*network_status_cb)(int state);
+} CtdlIPC;
+
+/* C constructor */
+CtdlIPC* CtdlIPC_new(int argc, char **argv, char *hostbuf, char *portbuf);
+/* C destructor */
+void CtdlIPC_delete(CtdlIPC* ipc);
+/* Convenience destructor; also nulls out caller's pointer */
+void CtdlIPC_delete_ptr(CtdlIPC** pipc);
+/* Read a line from server, discarding newline */
+void CtdlIPC_getline(CtdlIPC* ipc, char *buf);
+/* Write a line to server, adding newline */
+void CtdlIPC_putline(CtdlIPC* ipc, const char *buf);
+
 struct ctdlipcroom {
        char RRname[ROOMNAMELEN];       /* Name of room */
        long RRunread;                  /* Number of unread messages */
@@ -20,18 +78,18 @@ struct parts {
        char number[16];                /* part number */
        char name[PATH_MAX];            /* Name */
        char filename[PATH_MAX];        /* Suggested filename */
-       char mimetype[256];             /* MIME type */
-       char disposition[256];          /* Content disposition */
+       char mimetype[SIZ];             /* MIME type */
+       char disposition[SIZ];          /* Content disposition */
        unsigned long length;           /* Content length */
 };
 
 
 struct ctdlipcmessage {
-       char msgid[256];                /* Original message ID */
-       char path[256];                 /* Return path to sender */
-       char zaps[256];                 /* Message ID that this supersedes */
-       char subject[256];              /* Message subject */
-       char email[256];                /* Email address of sender */
+       char msgid[SIZ];                /* Original message ID */
+       char path[SIZ];                 /* Return path to sender */
+       char zaps[SIZ];                 /* Message ID that this supersedes */
+       char subject[SIZ];              /* Message subject */
+       char email[SIZ];                /* Email address of sender */
        char author[USERNAME_SIZE];     /* Sender of message */
        char recipient[USERNAME_SIZE];  /* Recipient of message */
        char room[ROOMNAMELEN];         /* Originating room */
@@ -43,6 +101,19 @@ struct ctdlipcmessage {
        time_t time;                    /* Time message was posted */
        char nhdr;                      /* Suppress message header? */
        char anonymous;                 /* An anonymous message */
+       char mime_chosen[SIZ];          /* Chosen MIME part to output */
+       char content_type[SIZ];         /* How would you like that? */
+};
+
+
+struct ctdlipcfile {
+       char remote_name[PATH_MAX];     /* Filename on server */
+       char local_name[PATH_MAX];      /* Filename on client */
+       char description[80];           /* Description on server */
+       FILE *local_fd;                 /* Open file on client */
+       size_t size;                    /* Size of file in octets */
+       int upload:1;                   /* uploading? 0 if downloading */
+       int complete:1;                 /* Transfer has finished? */
 };
 
 
@@ -52,118 +123,201 @@ struct ctdlipcmisc {
        char needvalid;                 /* Nonzero if users need validation */
 };
 
-#ifdef __cplusplus
-extern "C" {
-#endif
+enum RoomList {
+       SubscribedRooms,
+       SubscribedRoomsWithNewMessages,
+       SubscribedRoomsWithNoNewMessages,
+       UnsubscribedRooms,
+       AllAccessibleRooms,
+       AllPublicRooms,
+};
+#define AllFloors -1
+enum MessageList {
+       AllMessages,
+       OldMessages,
+       NewMessages,
+       LastMessages,
+       FirstMessages,
+       MessagesGreaterThan,
+       MessagesLessThan,
+};
+enum MessageDirection {
+       ReadReverse = -1,
+       ReadForward = 1,
+};
+
+/* Shared Diffie-Hellman parameters */
+#define DH_P           "1A74527AEE4EE2568E85D4FB2E65E18C9394B9C80C42507D7A6A0DBE9A9A54B05A9A96800C34C7AA5297095B69C88901EEFD127F969DCA26A54C0E0B5C5473EBAEB00957D2633ECAE3835775425DE66C0DE6D024DBB17445E06E6B0C78415E589B8814F08531D02FD43778451E7685541079CFFB79EF0D26EFEEBBB69D1E80383"
+#define DH_G           "2"
+#define DH_L           1024
+#define CIT_CIPHERS    "ALL:RC4+RSA:+SSLv2:@STRENGTH"  /* see ciphers(1) */
 
-int CtdlIPCNoop(void);
-int CtdlIPCEcho(const char *arg, char *cret);
-int CtdlIPCQuit(void);
-int CtdlIPCLogout(void);
-int CtdlIPCTryLogin(const char *username, char *cret);
-int CtdlIPCTryPassword(const char *passwd, char *cret);
-int CtdlIPCCreateUser(const char *username, char *cret);
-int CtdlIPCChangePassword(const char *passwd, char *cret);
-int CtdlIPCKnownRooms(int which, int floor, struct march **listing, char *cret);
-int CtdlIPCGetConfig(struct usersupp **uret, char *cret);
-int CtdlIPCSetConfig(struct usersupp *uret, char *cret);
-int CtdlIPCGotoRoom(const char *room, const char *passwd,
+int CtdlIPCNoop(CtdlIPC *ipc);
+int CtdlIPCEcho(CtdlIPC *ipc, const char *arg, char *cret);
+int CtdlIPCQuit(CtdlIPC *ipc);
+int CtdlIPCLogout(CtdlIPC *ipc);
+int CtdlIPCTryLogin(CtdlIPC *ipc, const char *username, char *cret);
+int CtdlIPCTryPassword(CtdlIPC *ipc, const char *passwd, char *cret);
+int CtdlIPCTryApopPassword(CtdlIPC *ipc, const char *response, char *cret);
+int CtdlIPCCreateUser(CtdlIPC *ipc, const char *username, int selfservice,
+               char *cret);
+int CtdlIPCChangePassword(CtdlIPC *ipc, const char *passwd, char *cret);
+int CtdlIPCKnownRooms(CtdlIPC *ipc, enum RoomList which, int floor,
+               struct march **listing, char *cret);
+int CtdlIPCGetConfig(CtdlIPC *ipc, struct ctdluser **uret, char *cret);
+int CtdlIPCSetConfig(CtdlIPC *ipc, struct ctdluser *uret, char *cret);
+int CtdlIPCGotoRoom(CtdlIPC *ipc, const char *room, const char *passwd,
                struct ctdlipcroom **rret, char *cret);
-int CtdlIPCGetMessages(int which, int whicharg, const char *template,
-               long **mret, char *cret);
-int CtdlIPCGetSingleMessage(long msgnum, int headers, int as_mime,
+int CtdlIPCGetMessages(CtdlIPC *ipc, enum MessageList which, int whicharg,
+               const char *mtemplate, unsigned long **mret, char *cret);
+int CtdlIPCGetSingleMessage(CtdlIPC *ipc, long msgnum, int headers, int as_mime,
                struct ctdlipcmessage **mret, char *cret);
-int CtdlIPCWhoKnowsRoom(char **listing, char *cret);
-int CtdlIPCServerInfo(char **listing, char *cret);
-int CtdlIPCReadDirectory(char **listing, char *cret);
-int CtdlIPCSetLastRead(long msgnum, char *cret);
-int CtdlIPCInviteUserToRoom(const char *username, char *cret);
-int CtdlIPCKickoutUserFromRoom(const char *username, char *cret);
-int CtdlIPCGetRoomAttributes(struct quickroom **qret, char *cret);
-int CtdlIPCSetRoomAttributes(int forget, struct quickroom *qret, char *cret);
-int CtdlIPCGetRoomAide(char *cret);
-int CtdlIPCSetRoomAide(const char *username, char *cret);
-int CtdlIPCPostMessage(int flag, const struct ctdlipcmessage *mr, char *cret);
-int CtdlIPCRoomInfo(char **iret, char *cret);
-int CtdlIPCDeleteMessage(long msgnum, char *cret);
-int CtdlIPCMoveMessage(int copy, long msgnum, const char *destroom, char *cret);
-int CtdlIPCDeleteRoom(int for_real, char *cret);
-int CtdlIPCCreateRoom(int for_real, const char *roomname, int type,
-               const char *password, int floor, char *cret);
-int CtdlIPCForgetRoom(char *cret);
-int CtdlIPCSystemMessage(const char *message, char **mret, char *cret);
-int CtdlIPCNextUnvalidatedUser(char *cret);
-int CtdlIPCGetUserRegistration(const char *username, char **rret, char *cret);
-int CtdlIPCValidateUser(const char *username, int axlevel, char *cret);
-int CtdlIPCSetRoomInfo(int for_real, const char *info, char *cret);
-int CtdlIPCUserListing(char **list, char *cret);
-int CtdlIPCSetRegistration(const char *info, char *cret);
-int CtdlIPCMiscCheck(struct ctdlipcmisc *chek, char *cret);
-int CtdlIPCDeleteFile(const char *filename, char *cret);
-int CtdlIPCMoveFile(const char *filename, const char *destroom, char *cret);
-int CtdlIPCNetSendFile(const char *filename, const char *destnode, char *cret);
-int CtdlIPCOnlineUsers(char **listing, time_t *stamp, char *cret);
-int CtdlIPCFileDownload(const char *filename, void **buf, char *cret);
-int CtdlIPCAttachmentDownload(long msgnum, const char *part, void **buf,
-               char *cret);
-int CtdlIPCImageDownload(const char *filename, void **buf, char *cret);
-int CtdlIPCFileUpload(const char *filename, const char *comment, void *buf,
-               size_t bytes, char *cret);
-int CtdlIPCImageUpload(int for_real, const char *filename, size_t bytes,
-               char *cret);
-int CtdlIPCQueryUsername(const char *username, char *cret);
-int CtdlIPCFloorListing(char **listing, char *cret);
-int CtdlIPCCreateFloor(int for_real, const char *name, char *cret);
-int CtdlIPCDeleteFloor(int for_real, int floornum, char *cret);
-int CtdlIPCEditFloor(int floornum, const char *floorname, char *cret);
-int CtdlIPCIdentifySoftware(int developerid, int clientid, int revision,
-               const char *software_name, const char *hostname, char *cret);
-int CtdlIPCSendInstantMessage(const char *username, const char *text,
-               char *cret);
-int CtdlIPCGetInstantMessage(char **listing, char *cret);
-int CtdlIPCEnableInstantMessageReceipt(int mode, char *cret);
-int CtdlIPCSetBio(char *bio, char *cret);
-int CtdlIPCGetBio(const char *username, char **listing, char *cret);
-int CtdlIPCListUsersWithBios(char **listing, char *cret);
-int CtdlIPCStealthMode(int mode, char *cret);
-int CtdlIPCTerminateSession(int sid, char *cret);
-int CtdlIPCTerminateServerNow(char *cret);
-int CtdlIPCTerminateServerScheduled(int mode, char *cret);
-int CtdlIPCEnterSystemMessage(const char *filename, const char *text,
-               char *cret);
-int CtdlIPCChangeHostname(const char *hostname, char *cret);
-int CtdlIPCChangeRoomname(const char *roomname, char *cret);
-int CtdlIPCChangeUsername(const char *username, char *cret);
-time_t CtdlIPCServerTime(char *crert);
-int CtdlIPCAideGetUserParameters(struct usersupp **uret, char *cret);
-int CtdlIPCAideSetUserParameters(const struct usersupp *uret, char *cret);
-int CtdlIPCGetMessageExpirationPolicy(int which, char *cret);
-int CtdlIPCSetMessageExpirationPolicy(int which, int policy, int value,
-               char *cret);
-int CtdlGetSystemConfig(char **listing, char *cret);
-int CtdlSetSystemConfig(const char *listing, char *cret);
-int CtdlIPCModerateMessage(long msgnum, int level, char *cret);
-int CtdlIPCRequestClientLogout(int session, char *cret);
-int CtdlIPCSetMessageSeen(long msgnum, int seen, char *cret);
-int CtdlIPCStartEncryption(char *cret);
+int CtdlIPCWhoKnowsRoom(CtdlIPC *ipc, char **listing, char *cret);
+int CtdlIPCServerInfo(CtdlIPC *ipc, struct CtdlServInfo *ServInfo, char *cret);
+/* int CtdlIPCReadDirectory(CtdlIPC *ipc, struct ctdlipcfile **files, char *cret); */
+int CtdlIPCReadDirectory(CtdlIPC *ipc, char **listing, char *cret);
+int CtdlIPCSetLastRead(CtdlIPC *ipc, long msgnum, char *cret);
+int CtdlIPCInviteUserToRoom(CtdlIPC *ipc, const char *username, char *cret);
+int CtdlIPCKickoutUserFromRoom(CtdlIPC *ipc, const char *username, char *cret);
+int CtdlIPCGetRoomAttributes(CtdlIPC *ipc, struct ctdlroom **qret, char *cret);
+int CtdlIPCSetRoomAttributes(CtdlIPC *ipc, int forget, struct ctdlroom *qret,
+               char *cret);
+int CtdlIPCGetRoomAide(CtdlIPC *ipc, char *cret);
+int CtdlIPCSetRoomAide(CtdlIPC *ipc, const char *username, char *cret);
+int CtdlIPCPostMessage(CtdlIPC *ipc, int flag, const struct ctdlipcmessage *mr,
+               char *cret);
+int CtdlIPCRoomInfo(CtdlIPC *ipc, char **iret, char *cret);
+int CtdlIPCDeleteMessage(CtdlIPC *ipc, long msgnum, char *cret);
+int CtdlIPCMoveMessage(CtdlIPC *ipc, int copy, long msgnum,
+               const char *destroom, char *cret);
+int CtdlIPCDeleteRoom(CtdlIPC *ipc, int for_real, char *cret);
+int CtdlIPCCreateRoom(CtdlIPC *ipc, int for_real, const char *roomname,
+               int type, const char *password, int floor, char *cret);
+int CtdlIPCForgetRoom(CtdlIPC *ipc, char *cret);
+int CtdlIPCSystemMessage(CtdlIPC *ipc, const char *message, char **mret,
+               char *cret);
+int CtdlIPCNextUnvalidatedUser(CtdlIPC *ipc, char *cret);
+int CtdlIPCGetUserRegistration(CtdlIPC *ipc, const char *username, char **rret,
+               char *cret);
+int CtdlIPCValidateUser(CtdlIPC *ipc, const char *username, int axlevel,
+               char *cret);
+int CtdlIPCSetRoomInfo(CtdlIPC *ipc, int for_real, const char *info,
+               char *cret);
+int CtdlIPCUserListing(CtdlIPC *ipc, char **list, char *cret);
+int CtdlIPCSetRegistration(CtdlIPC *ipc, const char *info, char *cret);
+int CtdlIPCMiscCheck(CtdlIPC *ipc, struct ctdlipcmisc *chek, char *cret);
+int CtdlIPCDeleteFile(CtdlIPC *ipc, const char *filename, char *cret);
+int CtdlIPCMoveFile(CtdlIPC *ipc, const char *filename, const char *destroom,
+               char *cret);
+int CtdlIPCNetSendFile(CtdlIPC *ipc, const char *filename,
+               const char *destnode, char *cret);
+int CtdlIPCOnlineUsers(CtdlIPC *ipc, char **listing, time_t *stamp, char *cret);
+int CtdlIPCFileDownload(CtdlIPC *ipc, const char *filename, void **buf,
+               size_t resume,
+               void (*progress_gauge_callback)(unsigned long, unsigned long),
+               char *cret);
+int CtdlIPCAttachmentDownload(CtdlIPC *ipc, long msgnum, const char *part,
+               void **buf,
+               void (*progress_gauge_callback)(unsigned long, unsigned long),
+               char *cret);
+int CtdlIPCImageDownload(CtdlIPC *ipc, const char *filename, void **buf,
+               void (*progress_gauge_callback)(unsigned long, unsigned long),
+               char *cret);
+int CtdlIPCFileUpload(CtdlIPC *ipc, const char *save_as, const char *comment,
+               const char *path,
+               void (*progress_gauge_callback)(unsigned long, unsigned long),
+               char *cret);
+int CtdlIPCImageUpload(CtdlIPC *ipc, int for_real, const char *path,
+               const char *save_as,
+               void (*progress_gauge_callback)(unsigned long, unsigned long),
+               char *cret);
+int CtdlIPCQueryUsername(CtdlIPC *ipc, const char *username, char *cret);
+int CtdlIPCFloorListing(CtdlIPC *ipc, char **listing, char *cret);
+int CtdlIPCCreateFloor(CtdlIPC *ipc, int for_real, const char *name,
+               char *cret);
+int CtdlIPCDeleteFloor(CtdlIPC *ipc, int for_real, int floornum, char *cret);
+int CtdlIPCEditFloor(CtdlIPC *ipc, int floornum, const char *floorname,
+               char *cret);
+int CtdlIPCIdentifySoftware(CtdlIPC *ipc, int developerid, int clientid,
+               int revision, const char *software_name, const char *hostname,
+               char *cret);
+int CtdlIPCSendInstantMessage(CtdlIPC *ipc, const char *username,
+               const char *text, char *cret);
+int CtdlIPCGetInstantMessage(CtdlIPC *ipc, char **listing, char *cret);
+int CtdlIPCEnableInstantMessageReceipt(CtdlIPC *ipc, int mode, char *cret);
+int CtdlIPCSetBio(CtdlIPC *ipc, char *bio, char *cret);
+int CtdlIPCGetBio(CtdlIPC *ipc, const char *username, char **listing,
+               char *cret);
+int CtdlIPCListUsersWithBios(CtdlIPC *ipc, char **listing, char *cret);
+int CtdlIPCStealthMode(CtdlIPC *ipc, int mode, char *cret);
+int CtdlIPCTerminateSession(CtdlIPC *ipc, int sid, char *cret);
+int CtdlIPCTerminateServerNow(CtdlIPC *ipc, char *cret);
+int CtdlIPCTerminateServerScheduled(CtdlIPC *ipc, int mode, char *cret);
+int CtdlIPCEnterSystemMessage(CtdlIPC *ipc, const char *filename, const char *text,
+               char *cret);
+int CtdlIPCChangeHostname(CtdlIPC *ipc, const char *hostname, char *cret);
+int CtdlIPCChangeRoomname(CtdlIPC *ipc, const char *roomname, char *cret);
+int CtdlIPCChangeUsername(CtdlIPC *ipc, const char *username, char *cret);
+time_t CtdlIPCServerTime(CtdlIPC *ipc, char *crert);
+int CtdlIPCAideGetUserParameters(CtdlIPC *ipc, const char *who,
+                                struct ctdluser **uret, char *cret);
+int CtdlIPCAideSetUserParameters(CtdlIPC *ipc, const struct ctdluser *uret, char *cret);
+int CtdlIPCGetMessageExpirationPolicy(CtdlIPC *ipc, int which,
+               struct ExpirePolicy **policy, char *cret);
+int CtdlIPCSetMessageExpirationPolicy(CtdlIPC *ipc, int which,
+               struct ExpirePolicy *policy, char *cret);
+int CtdlIPCGetSystemConfig(CtdlIPC *ipc, char **listing, char *cret);
+int CtdlIPCSetSystemConfig(CtdlIPC *ipc, const char *listing, char *cret);
+int CtdlIPCGetSystemConfigByType(CtdlIPC *ipc, const char *mimetype,
+               char **listing, char *cret);
+int CtdlIPCSetSystemConfigByType(CtdlIPC *ipc, const char *mimetype,
+              const char *listing, char *cret);
+int CtdlIPCRequestClientLogout(CtdlIPC *ipc, int session, char *cret);
+int CtdlIPCSetMessageSeen(CtdlIPC *ipc, long msgnum, int seen, char *cret);
+int CtdlIPCStartEncryption(CtdlIPC *ipc, char *cret);
+int CtdlIPCDirectoryLookup(CtdlIPC *ipc, const char *address, char *cret);
+int CtdlIPCSpecifyPreferredFormats(CtdlIPC *ipc, char *cret, char *formats);
+int CtdlIPCInternalProgram(CtdlIPC *ipc, int secret, char *cret);
+int CtdlIPCMessageBaseCheck(CtdlIPC *ipc, char **mret, char *cret);
 
 /* ************************************************************************** */
 /*             Stuff below this line is not for public consumption            */
 /* ************************************************************************** */
 
-inline void netio_lock(void);
-inline void netio_unlock(void);
-char *CtdlIPCReadListing(char *dest);
-int CtdlIPCSendListing(const char *listing);
-size_t CtdlIPCPartialRead(void **buf, size_t offset, size_t bytes, char *cret);
-int CtdlIPCEndUpload(char *cret);
-int CtdlIPCWriteUpload(void *buf, size_t bytes, char *cret);
-int CtdlIPCEndDownload(char *cret);
-int CtdlIPCReadDownload(void **buf, size_t bytes, char *cret);
-int CtdlIPCGenericCommand(const char *command, const char *to_send,
-               size_t bytes_to_send, char **to_receive,
+inline void CtdlIPC_lock(CtdlIPC *ipc);
+inline void CtdlIPC_unlock(CtdlIPC *ipc);
+char *CtdlIPCReadListing(CtdlIPC *ipc, char *dest);
+int CtdlIPCSendListing(CtdlIPC *ipc, const char *listing);
+size_t CtdlIPCPartialRead(CtdlIPC *ipc, void **buf, size_t offset,
+               size_t bytes, char *cret);
+int CtdlIPCEndUpload(CtdlIPC *ipc, int discard, char *cret);
+int CtdlIPCWriteUpload(CtdlIPC *ipc, const char *path,
+               void (*progress_gauge_callback)(unsigned long, unsigned long),
+               char *cret);
+int CtdlIPCEndDownload(CtdlIPC *ipc, char *cret);
+int CtdlIPCReadDownload(CtdlIPC *ipc, void **buf, size_t bytes, size_t resume,
+               void (*progress_gauge_callback)(unsigned long, unsigned long),
+               char *cret);
+int CtdlIPCHighSpeedReadDownload(CtdlIPC *ipc, void **buf, size_t bytes,
+               size_t resume,
+               void (*progress_gauge_callback)(unsigned long, unsigned long),
+               char *cret);
+int CtdlIPCGenericCommand(CtdlIPC *ipc, const char *command,
+               const char *to_send, size_t bytes_to_send, char **to_receive,
                size_t *bytes_to_receive, char *proto_response);
 
+/* Internals */
+int starttls(CtdlIPC *ipc);
+void setCryptoStatusHook(void (*hook)(char *s));
+void CtdlIPC_SetNetworkStatusCallback(CtdlIPC *ipc, void (*hook)(int state));
+/* This is all Ford's doing.  FIXME: figure out what it's doing */
+extern int (*error_printf)(char *s, ...);
+void setIPCDeathHook(void (*hook)(void));
+void setIPCErrorPrintf(int (*func)(char *s, ...));
+void connection_died(CtdlIPC *ipc);
+int CtdlIPC_getsockfd(CtdlIPC* ipc);
+char CtdlIPC_get(CtdlIPC* ipc);
+
 #ifdef __cplusplus
 }
 #endif