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