textclient/src/include/citadel_ipc.h

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