citadel/citadel_ipc.h

   1 /* $Id$ */
   2
   3 #define UDS                     "_UDS_"
   4 #ifdef __CYGWIN__
   5 #define DEFAULT_HOST            "localhost"
   6 #else
   7 #define DEFAULT_HOST            UDS
   8 #endif
   9 #define DEFAULT_PORT            "citadel"
  10
  11 #include "sysdep.h"
  12 #include "server.h"
  13 #ifdef HAVE_PTHREAD_H
  14 #include <pthread.h>
  15 #endif
  16 #ifdef HAVE_OPENSSL
  17 #include <openssl/ssl.h>
  18 #include <openssl/err.h>
  19 #include <openssl/rand.h>
  20 #endif
  21
  22 #ifdef __cplusplus
  23 extern "C" {
  24 #endif
  25
  26 /* Quick and dirty hack; we don't want to use malloc() in C++ */
  27 #ifdef __cplusplus
  28 #define ialloc(t)       new t()
  29 #define ifree(o)        delete o
  30 #else
  31 #define ialloc(t)       malloc(sizeof(t))
  32 #define ifree(o)        free(o);
  33 #endif
  34
  35 /* This class is responsible for the server connection */
  36 typedef struct _CtdlIPC {
  37 #if defined(HAVE_OPENSSL)
  38         /* NULL if not encrypted, non-NULL otherwise */
  39         SSL *ssl;
  40 #endif
  41 #if defined(HAVE_PTHREAD_H)
  42         /* Fast mutex, call CtdlIPC_lock() or CtdlIPC_unlock() to use */
  43         pthread_mutex_t mutex;
  44 #endif
  45         /* -1 if not connected, >= 0 otherwise */
  46         int sock;
  47         /* 1 if server is local, 0 otherwise or if not connected */
  48         int isLocal;
  49         /* 1 if a download is open on the server, 0 otherwise */
  50         int downloading;
  51         /* 1 if an upload is open on the server, 0 otherwise */
  52         int uploading;
  53         /* Time the last command was sent to the server */
  54         time_t last_command_sent;
  55         /* Callback for update on whether the IPC is locked */
  56         void (*network_status_cb)(int state);
  57 } CtdlIPC;
  58
  59 /* C constructor */
  60 CtdlIPC* CtdlIPC_new(int argc, char **argv, char *hostbuf, char *portbuf);
  61 /* C destructor */
  62 void CtdlIPC_delete(CtdlIPC* ipc);
  63 /* Convenience destructor; also nulls out caller's pointer */
  64 void CtdlIPC_delete_ptr(CtdlIPC** pipc);
  65 /* Read a line from server, discarding newline */
  66 void CtdlIPC_getline(CtdlIPC* ipc, char *buf);
  67 /* Write a line to server, adding newline */
  68 void CtdlIPC_putline(CtdlIPC* ipc, const char *buf);
  69
  70 struct ctdlipcroom {
  71         char RRname[ROOMNAMELEN];       /* Name of room */
  72         long RRunread;                  /* Number of unread messages */
  73         long RRtotal;                   /* Total number of messages in room */
  74         char RRinfoupdated;             /* Nonzero if info was updated */
  75         unsigned RRflags;               /* Various flags (see LKRN) */
  76         long RRhighest;                 /* Highest message number in room */
  77         long RRlastread;                /* Highest message user has read */
  78         char RRismailbox;               /* Is this room a mailbox room? */
  79         char RRaide;                    /* User can do aide commands in room */
  80         long RRnewmail;                 /* Number of new mail messages */
  81         char RRfloor;                   /* Which floor this room is on */
  82 };
  83
  84
  85 struct parts {
  86         struct parts *next;
  87         char number[16];                /* part number */
  88         char name[PATH_MAX];            /* Name */
  89         char filename[PATH_MAX];        /* Suggested filename */
  90         char mimetype[SIZ];             /* MIME type */
  91         char disposition[SIZ];          /* Content disposition */
  92         unsigned long length;           /* Content length */
  93 };
  94
  95
  96 struct ctdlipcmessage {
  97         char msgid[SIZ];                /* Original message ID */
  98         char path[SIZ];                 /* Return path to sender */
  99         char zaps[SIZ];                 /* Message ID that this supersedes */
 100         char subject[SIZ];              /* Message subject */
 101         char email[SIZ];                /* Email address of sender */
 102         char author[SIZ];               /* Sender of message */
 103         char recipient[SIZ];            /* Recipient of message */
 104         char room[SIZ];                 /* Originating room */
 105         char node[SIZ];                 /* Short nodename of origin system */
 106         char hnod[SIZ];                 /* Humannode of origin system */
 107         struct parts *attachments;      /* Available attachments */
 108         char *text;                     /* Message text */
 109         int type;                       /* Message type */
 110         time_t time;                    /* Time message was posted */
 111         char nhdr;                      /* Suppress message header? */
 112         char anonymous;                 /* An anonymous message */
 113         char mime_chosen[SIZ];          /* Chosen MIME part to output */
 114         char content_type[SIZ];         /* How would you like that? */
 115 };
 116
 117
 118 struct ctdlipcfile {
 119         char remote_name[PATH_MAX];     /* Filename on server */
 120         char local_name[PATH_MAX];      /* Filename on client */
 121         char description[80];           /* Description on server */
 122         FILE *local_fd;                 /* Open file on client */
 123         size_t size;                    /* Size of file in octets */
 124         int upload:1;                   /* uploading? 0 if downloading */
 125         int complete:1;                 /* Transfer has finished? */
 126 };
 127
 128
 129 struct ctdlipcmisc {
 130         long newmail;                   /* Number of new Mail messages */
 131         char needregis;                 /* Nonzero if user needs to register */
 132         char needvalid;                 /* Nonzero if users need validation */
 133 };
 134
 135 enum RoomList {
 136         SubscribedRooms,
 137         SubscribedRoomsWithNewMessages,
 138         SubscribedRoomsWithNoNewMessages,
 139         UnsubscribedRooms,
 140         AllAccessibleRooms,
 141         AllPublicRooms,
 142 };
 143 #define AllFloors -1
 144 enum MessageList {
 145         AllMessages,
 146         OldMessages,
 147         NewMessages,
 148         LastMessages,
 149         FirstMessages,
 150         MessagesGreaterThan,
 151         MessagesLessThan,
 152 };
 153 enum MessageDirection {
 154         ReadReverse = -1,
 155         ReadForward = 1,
 156 };
 157
 158 /* Shared Diffie-Hellman parameters */
 159 #define DH_P            "1A74527AEE4EE2568E85D4FB2E65E18C9394B9C80C42507D7A6A0DBE9A9A54B05A9A96800C34C7AA5297095B69C88901EEFD127F969DCA26A54C0E0B5C5473EBAEB00957D2633ECAE3835775425DE66C0DE6D024DBB17445E06E6B0C78415E589B8814F08531D02FD43778451E7685541079CFFB79EF0D26EFEEBBB69D1E80383"
 160 #define DH_G            "2"
 161 #define DH_L            1024
 162 #define CIT_CIPHERS     "ALL:RC4+RSA:+SSLv2:@STRENGTH"  /* see ciphers(1) */
 163
 164 int CtdlIPCNoop(CtdlIPC *ipc);
 165 int CtdlIPCEcho(CtdlIPC *ipc, const char *arg, char *cret);
 166 int CtdlIPCQuit(CtdlIPC *ipc);
 167 int CtdlIPCLogout(CtdlIPC *ipc);
 168 int CtdlIPCTryLogin(CtdlIPC *ipc, const char *username, char *cret);
 169 int CtdlIPCTryPassword(CtdlIPC *ipc, const char *passwd, char *cret);
 170 int CtdlIPCTryApopPassword(CtdlIPC *ipc, const char *response, char *cret);
 171 int CtdlIPCCreateUser(CtdlIPC *ipc, const char *username, int selfservice,
 172                 char *cret);
 173 int CtdlIPCChangePassword(CtdlIPC *ipc, const char *passwd, char *cret);
 174 int CtdlIPCKnownRooms(CtdlIPC *ipc, enum RoomList which, int floor,
 175                 struct march **listing, char *cret);
 176 int CtdlIPCGetConfig(CtdlIPC *ipc, struct ctdluser **uret, char *cret);
 177 int CtdlIPCSetConfig(CtdlIPC *ipc, struct ctdluser *uret, char *cret);
 178 int CtdlIPCGotoRoom(CtdlIPC *ipc, const char *room, const char *passwd,
 179                 struct ctdlipcroom **rret, char *cret);
 180 int CtdlIPCGetMessages(CtdlIPC *ipc, enum MessageList which, int whicharg,
 181                 const char *mtemplate, unsigned long **mret, char *cret);
 182 int CtdlIPCGetSingleMessage(CtdlIPC *ipc, long msgnum, int headers, int as_mime,
 183                 struct ctdlipcmessage **mret, char *cret);
 184 int CtdlIPCWhoKnowsRoom(CtdlIPC *ipc, char **listing, char *cret);
 185 int CtdlIPCServerInfo(CtdlIPC *ipc, struct CtdlServInfo *ServInfo, char *cret);
 186 /* int CtdlIPCReadDirectory(CtdlIPC *ipc, struct ctdlipcfile **files, char *cret); */
 187 int CtdlIPCReadDirectory(CtdlIPC *ipc, char **listing, char *cret);
 188 int CtdlIPCSetLastRead(CtdlIPC *ipc, long msgnum, char *cret);
 189 int CtdlIPCInviteUserToRoom(CtdlIPC *ipc, const char *username, char *cret);
 190 int CtdlIPCKickoutUserFromRoom(CtdlIPC *ipc, const char *username, char *cret);
 191 int CtdlIPCGetRoomAttributes(CtdlIPC *ipc, struct ctdlroom **qret, char *cret);
 192 int CtdlIPCSetRoomAttributes(CtdlIPC *ipc, int forget, struct ctdlroom *qret,
 193                 char *cret);
 194 int CtdlIPCGetRoomAide(CtdlIPC *ipc, char *cret);
 195 int CtdlIPCSetRoomAide(CtdlIPC *ipc, const char *username, char *cret);
 196 int CtdlIPCPostMessage(CtdlIPC *ipc, int flag, const struct ctdlipcmessage *mr,
 197                 char *cret);
 198 int CtdlIPCRoomInfo(CtdlIPC *ipc, char **iret, char *cret);
 199 int CtdlIPCDeleteMessage(CtdlIPC *ipc, long msgnum, char *cret);
 200 int CtdlIPCMoveMessage(CtdlIPC *ipc, int copy, long msgnum,
 201                 const char *destroom, char *cret);
 202 int CtdlIPCDeleteRoom(CtdlIPC *ipc, int for_real, char *cret);
 203 int CtdlIPCCreateRoom(CtdlIPC *ipc, int for_real, const char *roomname,
 204                 int type, const char *password, int floor, char *cret);
 205 int CtdlIPCForgetRoom(CtdlIPC *ipc, char *cret);
 206 int CtdlIPCSystemMessage(CtdlIPC *ipc, const char *message, char **mret,
 207                 char *cret);
 208 int CtdlIPCNextUnvalidatedUser(CtdlIPC *ipc, char *cret);
 209 int CtdlIPCGetUserRegistration(CtdlIPC *ipc, const char *username, char **rret,
 210                 char *cret);
 211 int CtdlIPCValidateUser(CtdlIPC *ipc, const char *username, int axlevel,
 212                 char *cret);
 213 int CtdlIPCSetRoomInfo(CtdlIPC *ipc, int for_real, const char *info,
 214                 char *cret);
 215 int CtdlIPCUserListing(CtdlIPC *ipc, char **list, char *cret);
 216 int CtdlIPCSetRegistration(CtdlIPC *ipc, const char *info, char *cret);
 217 int CtdlIPCMiscCheck(CtdlIPC *ipc, struct ctdlipcmisc *chek, char *cret);
 218 int CtdlIPCDeleteFile(CtdlIPC *ipc, const char *filename, char *cret);
 219 int CtdlIPCMoveFile(CtdlIPC *ipc, const char *filename, const char *destroom,
 220                 char *cret);
 221 int CtdlIPCNetSendFile(CtdlIPC *ipc, const char *filename,
 222                 const char *destnode, char *cret);
 223 int CtdlIPCOnlineUsers(CtdlIPC *ipc, char **listing, time_t *stamp, char *cret);
 224 int CtdlIPCFileDownload(CtdlIPC *ipc, const char *filename, void **buf,
 225                 size_t resume,
 226                 void (*progress_gauge_callback)(unsigned long, unsigned long),
 227                 char *cret);
 228 int CtdlIPCAttachmentDownload(CtdlIPC *ipc, long msgnum, const char *part,
 229                 void **buf,
 230                 void (*progress_gauge_callback)(unsigned long, unsigned long),
 231                 char *cret);
 232 int CtdlIPCImageDownload(CtdlIPC *ipc, const char *filename, void **buf,
 233                 void (*progress_gauge_callback)(unsigned long, unsigned long),
 234                 char *cret);
 235 int CtdlIPCFileUpload(CtdlIPC *ipc, const char *save_as, const char *comment,
 236                 const char *path,
 237                 void (*progress_gauge_callback)(unsigned long, unsigned long),
 238                 char *cret);
 239 int CtdlIPCImageUpload(CtdlIPC *ipc, int for_real, const char *path,
 240                 const char *save_as,
 241                 void (*progress_gauge_callback)(unsigned long, unsigned long),
 242                 char *cret);
 243 int CtdlIPCQueryUsername(CtdlIPC *ipc, const char *username, char *cret);
 244 int CtdlIPCFloorListing(CtdlIPC *ipc, char **listing, char *cret);
 245 int CtdlIPCCreateFloor(CtdlIPC *ipc, int for_real, const char *name,
 246                 char *cret);
 247 int CtdlIPCDeleteFloor(CtdlIPC *ipc, int for_real, int floornum, char *cret);
 248 int CtdlIPCEditFloor(CtdlIPC *ipc, int floornum, const char *floorname,
 249                 char *cret);
 250 int CtdlIPCIdentifySoftware(CtdlIPC *ipc, int developerid, int clientid,
 251                 int revision, const char *software_name, const char *hostname,
 252                 char *cret);
 253 int CtdlIPCSendInstantMessage(CtdlIPC *ipc, const char *username,
 254                 const char *text, char *cret);
 255 int CtdlIPCGetInstantMessage(CtdlIPC *ipc, char **listing, char *cret);
 256 int CtdlIPCEnableInstantMessageReceipt(CtdlIPC *ipc, int mode, char *cret);
 257 int CtdlIPCSetBio(CtdlIPC *ipc, char *bio, char *cret);
 258 int CtdlIPCGetBio(CtdlIPC *ipc, const char *username, char **listing,
 259                 char *cret);
 260 int CtdlIPCListUsersWithBios(CtdlIPC *ipc, char **listing, char *cret);
 261 int CtdlIPCStealthMode(CtdlIPC *ipc, int mode, char *cret);
 262 int CtdlIPCTerminateSession(CtdlIPC *ipc, int sid, char *cret);
 263 int CtdlIPCTerminateServerNow(CtdlIPC *ipc, char *cret);
 264 int CtdlIPCTerminateServerScheduled(CtdlIPC *ipc, int mode, char *cret);
 265 int CtdlIPCEnterSystemMessage(CtdlIPC *ipc, const char *filename, const char *text,
 266                 char *cret);
 267 int CtdlIPCChangeHostname(CtdlIPC *ipc, const char *hostname, char *cret);
 268 int CtdlIPCChangeRoomname(CtdlIPC *ipc, const char *roomname, char *cret);
 269 int CtdlIPCChangeUsername(CtdlIPC *ipc, const char *username, char *cret);
 270 time_t CtdlIPCServerTime(CtdlIPC *ipc, char *crert);
 271 int CtdlIPCAideGetUserParameters(CtdlIPC *ipc, const char *who,
 272                                  struct ctdluser **uret, char *cret);
 273 int CtdlIPCAideSetUserParameters(CtdlIPC *ipc, const struct ctdluser *uret, char *cret);
 274 int CtdlIPCGetMessageExpirationPolicy(CtdlIPC *ipc, int which,
 275                 struct ExpirePolicy **policy, char *cret);
 276 int CtdlIPCSetMessageExpirationPolicy(CtdlIPC *ipc, int which,
 277                 struct ExpirePolicy *policy, char *cret);
 278 int CtdlIPCGetSystemConfig(CtdlIPC *ipc, char **listing, char *cret);
 279 int CtdlIPCSetSystemConfig(CtdlIPC *ipc, const char *listing, char *cret);
 280 int CtdlIPCGetSystemConfigByType(CtdlIPC *ipc, const char *mimetype,
 281                 char **listing, char *cret);
 282 int CtdlIPCSetSystemConfigByType(CtdlIPC *ipc, const char *mimetype,
 283                const char *listing, char *cret);
 284 int CtdlIPCRequestClientLogout(CtdlIPC *ipc, int session, char *cret);
 285 int CtdlIPCSetMessageSeen(CtdlIPC *ipc, long msgnum, int seen, char *cret);
 286 int CtdlIPCStartEncryption(CtdlIPC *ipc, char *cret);
 287 int CtdlIPCDirectoryLookup(CtdlIPC *ipc, const char *address, char *cret);
 288 int CtdlIPCSpecifyPreferredFormats(CtdlIPC *ipc, char *cret, char *formats);
 289 int CtdlIPCInternalProgram(CtdlIPC *ipc, int secret, char *cret);
 290 int CtdlIPCMessageBaseCheck(CtdlIPC *ipc, char **mret, char *cret);
 291
 292 /* ************************************************************************** */
 293 /*             Stuff below this line is not for public consumption            */
 294 /* ************************************************************************** */
 295
 296 INLINE void CtdlIPC_lock(CtdlIPC *ipc);
 297 INLINE void CtdlIPC_unlock(CtdlIPC *ipc);
 298 char *CtdlIPCReadListing(CtdlIPC *ipc, char *dest);
 299 int CtdlIPCSendListing(CtdlIPC *ipc, const char *listing);
 300 size_t CtdlIPCPartialRead(CtdlIPC *ipc, void **buf, size_t offset,
 301                 size_t bytes, char *cret);
 302 int CtdlIPCEndUpload(CtdlIPC *ipc, int discard, char *cret);
 303 int CtdlIPCWriteUpload(CtdlIPC *ipc, const char *path,
 304                 void (*progress_gauge_callback)(unsigned long, unsigned long),
 305                 char *cret);
 306 int CtdlIPCEndDownload(CtdlIPC *ipc, char *cret);
 307 int CtdlIPCReadDownload(CtdlIPC *ipc, void **buf, size_t bytes, size_t resume,
 308                 void (*progress_gauge_callback)(unsigned long, unsigned long),
 309                 char *cret);
 310 int CtdlIPCHighSpeedReadDownload(CtdlIPC *ipc, void **buf, size_t bytes,
 311                 size_t resume,
 312                 void (*progress_gauge_callback)(unsigned long, unsigned long),
 313                 char *cret);
 314 int CtdlIPCGenericCommand(CtdlIPC *ipc, const char *command,
 315                 const char *to_send, size_t bytes_to_send, char **to_receive,
 316                 size_t *bytes_to_receive, char *proto_response);
 317
 318 /* Internals */
 319 int starttls(CtdlIPC *ipc);
 320 void setCryptoStatusHook(void (*hook)(char *s));
 321 void CtdlIPC_SetNetworkStatusCallback(CtdlIPC *ipc, void (*hook)(int state));
 322 /* This is all Ford's doing.  FIXME: figure out what it's doing */
 323 extern int (*error_printf)(char *s, ...);
 324 void setIPCDeathHook(void (*hook)(void));
 325 void setIPCErrorPrintf(int (*func)(char *s, ...));
 326 void connection_died(CtdlIPC *ipc);
 327 int CtdlIPC_getsockfd(CtdlIPC* ipc);
 328 char CtdlIPC_get(CtdlIPC* ipc);
 329
 330 #ifdef __cplusplus
 331 }
 332 #endif