textclient/textclient.h

   1 // Copyright (c) 1987-2020 by the citadel.org team
   2 //
   3 // This program is open source software.  Use, duplication, and/or
   4 // disclosure are subject to the GNU General Purpose License version 3.
   5 //
   6 // This program is distributed in the hope that it will be useful,
   7 // but WITHOUT ANY WARRANTY; without even the implied warranty of
   8 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   9 // GNU General Public License for more details.
  10
  11 #define UDS                     "_UDS_"
  12 #define DEFAULT_HOST            "localhost"
  13 #define DEFAULT_PORT            "504"
  14 #define CLIENT_VERSION          926
  15 #define CLIENT_TYPE             0
  16
  17 /* commands we can send to the stty_ctdl() routine */
  18 #define SB_NO_INTR              0               // set to Citadel client mode, i/q disabled
  19 #define SB_YES_INTR             1               // set to Citadel client mode, i/q enabled
  20 #define SB_SAVE                 2               // save settings
  21 #define SB_RESTORE              3               // restore settings
  22 #define SB_LAST                 4               // redo the last command sent
  23
  24 #define UGLISTLEN               100             // you get a ungoto list of this size */
  25 #define ROOMNAMELEN             128             // The size of a roomname string
  26 #define USERNAME_SIZE           64              // The size of a username string
  27 #define MAX_EDITORS             5               // number of external editors supported, must be at least 1
  28 #define NONCE_SIZE              128             // Added by <bc> to allow for APOP auth
  29
  30 #define S_KEEPALIVE             30              // How often (in seconds) to send keepalives to the server
  31
  32 #define READ_HEADER             2
  33 #define READ_MSGBODY            3
  34
  35 #define NUM_CONFIGS             72
  36
  37 #define NEXT_KEY                15
  38 #define STOP_KEY                3
  39
  40 /* citadel.rc stuff */
  41 #define RC_NO                   0               /* always no */
  42 #define RC_YES                  1               /* always yes */
  43 #define RC_DEFAULT              2               /* setting depends on user config */
  44
  45 /* keepalives */
  46 enum {
  47         KA_NO,                          /* no keepalives */
  48         KA_YES,                         /* full keepalives */
  49         KA_HALF                         /* half keepalives */
  50 };
  51
  52 /* for <;G>oto and <;S>kip commands */
  53 #define GF_GOTO         0               /* <;G>oto floor mode */
  54 #define GF_SKIP         1               /* <;S>kip floor mode */
  55 #define GF_ZAP          2               /* <;Z>ap floor mode */
  56
  57 /* Can messages be entered in this room? */
  58 #define ENTMSG_OK_NO    0               /* You may not enter messages here */
  59 #define ENTMSG_OK_YES   1               /* Go ahead! */
  60 #define ENTMSG_OK_BLOG  2               /* Yes, but warn the user about how blog rooms work */
  61
  62 /*
  63  * Colors for color() command
  64  */
  65 #define DIM_BLACK       0
  66 #define DIM_RED         1
  67 #define DIM_GREEN       2
  68 #define DIM_YELLOW      3
  69 #define DIM_BLUE        4
  70 #define DIM_MAGENTA     5
  71 #define DIM_CYAN        6
  72 #define DIM_WHITE       7
  73 #define BRIGHT_BLACK    8
  74 #define BRIGHT_RED      9
  75 #define BRIGHT_GREEN    10
  76 #define BRIGHT_YELLOW   11
  77 #define BRIGHT_BLUE     12
  78 #define BRIGHT_MAGENTA  13
  79 #define BRIGHT_CYAN     14
  80 #define BRIGHT_WHITE    15
  81 #define COLOR_PUSH      16      /* Save current color */
  82 #define COLOR_POP       17      /* Restore saved color */
  83 #define ORIGINAL_PAIR   -1      /* Default terminal colors */
  84
  85 typedef void (*sighandler_t)(int);
  86
  87
  88
  89 #include <stdlib.h>
  90 #include <unistd.h>
  91 #include <fcntl.h>
  92 #include <stdio.h>
  93 #include <ctype.h>
  94 #include <string.h>
  95 #include <time.h>
  96 #include <limits.h>
  97 #include <sys/types.h>
  98 #include <sys/wait.h>
  99 #include <sys/stat.h>
 100 #include <sys/ioctl.h>
 101 #include <termios.h>
 102 //      #include <sgtty.h>      not needed if we have termios.h
 103 #include <stdlib.h>
 104 #include <ctype.h>
 105 #include <sys/socket.h>
 106 #include <arpa/inet.h>
 107 #include <netinet/in.h>
 108 #include <netdb.h>
 109 #include <sys/un.h>
 110 #include <errno.h>
 111 #include <signal.h>
 112 #include <pwd.h>
 113 #include <stdarg.h>
 114 #include <errno.h>
 115 #include <signal.h>
 116 #include <malloc.h>
 117 #include <stdarg.h>
 118 #include <sys/select.h>
 119 #include <dirent.h>
 120 #include <libcitadel.h>
 121
 122 #include <limits.h>
 123 #ifdef HAVE_PTHREAD_H
 124 #include <pthread.h>
 125 #endif
 126 #ifdef HAVE_OPENSSL
 127 #include <openssl/ssl.h>
 128 #include <openssl/err.h>
 129 #include <openssl/rand.h>
 130 #endif
 131
 132
 133 struct CtdlServInfo {
 134         int pid;
 135         char nodename[32];
 136         char humannode[64];
 137         char fqdn[64];
 138         char software[64];
 139         int rev_level;
 140         char site_location[64];
 141         char sysadm[64];
 142         char moreprompt[256];
 143         int ok_floors;
 144         int supports_qnop;
 145         int supports_ldap;
 146         int newuser_disabled;
 147         char default_cal_zone[256];
 148         double load_avg;
 149         double worker_avg;
 150         int thread_count;
 151         int has_sieve;
 152         int fulltext_enabled;
 153         char svn_revision[256];
 154         int guest_logins;
 155 };
 156
 157
 158 /*
 159  * This class is responsible for the server connection
 160  */
 161 typedef struct _CtdlIPC {
 162         struct CtdlServInfo ServInfo;   /* The server info for this connection */
 163 #if defined(HAVE_OPENSSL)
 164         SSL *ssl;                       /* NULL if not encrypted, non-NULL otherwise */
 165 #endif
 166         int sock;                       /* Socket for connection to server, or -1 if not connected */
 167         int isLocal;                    /* 1 if server is local, 0 otherwise or if not connected */
 168         int downloading;                /* 1 if a download is open on the server, 0 otherwise */
 169         int uploading;                  /* 1 if an upload is open on the server, 0 otherwise */
 170         time_t last_command_sent;       /* Time the last command was sent to the server */
 171         char *Buf;                      /* Our buffer for linebuffered read. */
 172         size_t BufSize;
 173         size_t BufUsed;
 174         char *BufPtr;
 175         void (*network_status_cb)(int state);   /* Callback for update on whether the IPC is locked */
 176         char ip_hostname[256];          /* host name of server to which we are connected (if network) */
 177         char ip_address[64];            /* IP address of server to which we are connected (if network) */
 178 } CtdlIPC;
 179
 180 extern char *axdefs[];
 181 extern char *viewdefs[];
 182 extern char fullname[USERNAME_SIZE];
 183 extern unsigned room_flags;
 184 extern char room_name[ROOMNAMELEN];
 185 extern struct CtdlServInfo serv_info;
 186 extern char axlevel;
 187 extern char is_room_aide;
 188 extern unsigned userflags;
 189 extern char sigcaught;
 190 extern char editor_paths[MAX_EDITORS][SIZ];
 191 extern char printcmd[SIZ];
 192 extern char imagecmd[SIZ];
 193 extern char have_xterm;
 194 extern char rc_username[USERNAME_SIZE];
 195 extern char rc_password[32];
 196 extern char rc_floor_mode;
 197 extern time_t rc_idle_threshold;
 198 #ifdef HAVE_OPENSSL
 199 extern char rc_encrypt;                 /* from the citadel.rc file */
 200 extern char arg_encrypt;                /* from the command line */
 201 #endif
 202 #if defined(HAVE_CURSES_H) && !defined(DISABLE_CURSES)
 203 extern char rc_screen;
 204 extern char arg_screen;
 205 #endif
 206 extern char rc_alt_semantics;
 207 extern char instant_msgs;
 208 void ctdl_logoff(char *file, int line, CtdlIPC *ipc, int code);
 209 #define logoff(ipc, code)       ctdl_logoff(__FILE__, __LINE__, (ipc), (code))
 210 void formout(CtdlIPC *ipc, char *name);
 211 void sighandler(int which_sig);
 212 extern int secure;
 213 void remove_march(char *roomname, int floornum);
 214 void calc_dirs_n_files(int relh, int home, const char *relhome, char  *ctdldir, int dbg);
 215
 216 /*
 217  * This struct stores a list of rooms with new messages which the client
 218  * fetches from the server.  This allows the client to "march" through
 219  * relevant rooms without having to ask the server each time where to go next.
 220  */
 221 typedef struct ExpirePolicy ExpirePolicy;
 222 struct ExpirePolicy {
 223         int expire_mode;
 224         int expire_value;
 225 };
 226
 227 typedef struct march march;
 228 struct march {
 229         struct march *next;
 230         char march_name[ROOMNAMELEN];
 231         unsigned int march_flags;
 232         char march_floor;
 233         char march_order;
 234         unsigned int march_flags2;
 235         int march_access;
 236 };
 237
 238 /*
 239  * This is NOT the same 'struct ctdluser' from the server.
 240  */
 241 typedef struct ctdluser ctdluser;
 242 struct ctdluser {                       // User record
 243         int version;                    // Cit vers. which created this rec
 244         uid_t uid;                      // Associate with a unix account?
 245         char password[32];              // password
 246         unsigned flags;                 // See US_ flags below
 247         long timescalled;               // Total number of logins
 248         long posted;                    // Number of messages ever submitted
 249         uint8_t axlevel;                // Access level
 250         long usernum;                   // User number (never recycled)
 251         time_t lastcall;                // Date/time of most recent login
 252         int USuserpurge;                // Purge time (in days) for user
 253         char fullname[64];              // Display name (primary identifier)
 254         char emailaddrs[512];           // Internet email addresses
 255 };
 256
 257 typedef struct ctdlroom ctdlroom;
 258 struct ctdlroom {
 259         char QRname[ROOMNAMELEN];       /* Name of room                     */
 260         char QRpasswd[10];              /* Only valid if it's a private rm  */
 261         long QRroomaide;                /* User number of room aide         */
 262         long QRhighest;                 /* Highest message NUMBER in room   */
 263         time_t QRgen;                   /* Generation number of room        */
 264         unsigned QRflags;               /* See flag values below            */
 265         char QRdirname[15];             /* Directory name, if applicable    */
 266         long QRinfo;                    /* Info file update relative to msgs*/
 267         char QRfloor;                   /* Which floor this room is on      */
 268         time_t QRmtime;                 /* Date/time of last post           */
 269         struct ExpirePolicy QRep;       /* Message expiration policy        */
 270         long QRnumber;                  /* Globally unique room number      */
 271         char QRorder;                   /* Sort key for room listing order  */
 272         unsigned QRflags2;              /* Additional flags                 */
 273         int QRdefaultview;              /* How to display the contents      */
 274 };
 275
 276
 277 /* C constructor */
 278 CtdlIPC* CtdlIPC_new(int argc, char **argv, char *hostbuf, char *portbuf);
 279 /* C destructor */
 280 void CtdlIPC_delete(CtdlIPC* ipc);
 281 /* Convenience destructor; also nulls out caller's pointer */
 282 void CtdlIPC_delete_ptr(CtdlIPC** pipc);
 283 /* Read a line from server, discarding newline, for chat, will go away */
 284 void CtdlIPC_chat_recv(CtdlIPC* ipc, char *buf);
 285 /* Write a line to server, adding newline, for chat, will go away */
 286 void CtdlIPC_chat_send(CtdlIPC* ipc, const char *buf);
 287
 288 struct ctdlipcroom {
 289         char RRname[ROOMNAMELEN];       /* Name of room */
 290         long RRunread;                  /* Number of unread messages */
 291         long RRtotal;                   /* Total number of messages in room */
 292         char RRinfoupdated;             /* Nonzero if info was updated */
 293         unsigned RRflags;               /* Various flags (see LKRN) */
 294         unsigned RRflags2;              /* Various flags (see LKRN) */
 295         long RRhighest;                 /* Highest message number in room */
 296         long RRlastread;                /* Highest message user has read */
 297         char RRismailbox;               /* Is this room a mailbox room? */
 298         char RRaide;                    /* User can do aide commands in room */
 299         long RRnewmail;                 /* Number of new mail messages */
 300         char RRfloor;                   /* Which floor this room is on */
 301         char RRcurrentview;             /* The user's current view for this room */
 302         char RRdefaultview;             /* The default view for this room */
 303 };
 304
 305
 306 struct parts {
 307         struct parts *next;
 308         char number[16];                /* part number */
 309         char name[PATH_MAX];            /* Name */
 310         char filename[PATH_MAX];        /* Suggested filename */
 311         char mimetype[SIZ];             /* MIME type */
 312         char disposition[SIZ];          /* Content disposition */
 313         unsigned long length;           /* Content length */
 314 };
 315
 316
 317 struct ctdlipcmessage {
 318         char msgid[SIZ];                /* Original message ID */
 319         char path[SIZ];                 /* Return path to sender */
 320         char zaps[SIZ];                 /* Message ID that this supersedes */
 321         char subject[SIZ];              /* Message subject */
 322         char email[SIZ];                /* Email address of sender */
 323         char author[SIZ];               /* Sender of message */
 324         char recipient[SIZ];            /* Recipient of message */
 325         char room[SIZ];                 /* Originating room */
 326         struct parts *attachments;      /* Available attachments */
 327         char *text;                     /* Message text */
 328         int type;                       /* Message type */
 329         time_t time;                    /* Time message was posted */
 330         char nhdr;                      /* Suppress message header? */
 331         char anonymous;                 /* An anonymous message */
 332         char mime_chosen[SIZ];          /* Chosen MIME part to output */
 333         char content_type[SIZ];         /* How would you like that? */
 334         char references[SIZ];           /* Thread references */
 335         int is_local;                   /* Nonzero if the message originated on the local system */
 336 };
 337
 338
 339 struct ctdlipcfile {
 340         char remote_name[PATH_MAX];     /* Filename on server */
 341         char local_name[PATH_MAX];      /* Filename on client */
 342         char description[80];           /* Description on server */
 343         FILE *local_fd;                 /* Open file on client */
 344         size_t size;                    /* Size of file in octets */
 345         unsigned int upload:1;          /* uploading? 0 if downloading */
 346         unsigned int complete:1;        /* Transfer has finished? */
 347 };
 348
 349
 350 struct ctdlipcmisc {
 351         long newmail;                   /* Number of new Mail messages */
 352         char needregis;                 /* Nonzero if user needs to register */
 353         char needvalid;                 /* Nonzero if users need validation */
 354 };
 355
 356 enum RoomList {
 357         SubscribedRooms,
 358         SubscribedRoomsWithNewMessages,
 359         SubscribedRoomsWithNoNewMessages,
 360         UnsubscribedRooms,
 361         AllAccessibleRooms,
 362         AllPublicRooms
 363 };
 364 #define AllFloors -1
 365 enum MessageList {
 366         AllMessages,
 367         OldMessages,
 368         NewMessages,
 369         LastMessages,
 370         FirstMessages,
 371         MessagesGreaterThan,
 372         MessagesLessThan
 373 };
 374 enum MessageDirection {
 375         ReadReverse = -1,
 376         ReadForward = 1
 377 };
 378 extern char file_citadel_rc[PATH_MAX];
 379 extern char file_citadel_config[PATH_MAX];
 380
 381 /* Shared Diffie-Hellman parameters */
 382 #define DH_P            "F6E33BD70D475906ABCFB368DA2D1E5611D57DFDAC6A10CD78F406D6952519C74E21FFDCC5A780B9359722AACC8036E4CD24D5F5165EAC9EF226DBD9BBCF678F8DDEE86386F1BC20E291A9854A513A2CA326B411DC92E38F2ED2FEB6A3B792F13DB6550371FDBAC5ECA373BE5050CA4905431CA86088737D52B36C8D13CE9CB4EEF4C910285035E8329DD07551A80B87775676DD1067395CCEE9040C9B8BF998C528B3772B4C590A2CF18C5E58929BFCB538A62638B7437A9C68572D15287E97692B0B1EC5444D9DAB6EB062D20B79CA005EC5035065567AFD1FEF9B251D74747C6065D8C8B6B0862D1EE03F3A244C429EADE0CCC5C3A4196F5CBF5AA01A9026EFB20AA90E462BD64620278F271905EB604F38E6CFAE412EAA6C468E3B58170909BC18662FE2053224F30BE4FDB93BF9FBF969D91A5427A0665AC7BD1C43701B991094C92F7A935063055617142164F02973EB4ED86DD74D2BBAB3CD3B28F7BBD8D9F925B0FE92F7F7D0568D783F9ECE7AF96FB5AF274B586924B64639733A73ACA8F2BD1E970DF51ADDD983F7F6361A2B0DC4F086DE26D8656EC8813DE4B74D6D57BC1E690AC2FF1682B7E16938565A41D1DC64C75ADB81DA4582613FC68C0FDD327D35E2CDF20D009465303773EF3870FBDB0985EE7002A95D7912BBCC78187C29DB046763B7FABFF44EABE820F8ED0D7230AA0AF24F428F82448345BC099B"
 383 #define DH_G            "2"
 384 #define DH_L            4096
 385 #define CIT_CIPHERS     "ALL:RC4+RSA:+SSLv2:+TLSv1:!MD5:@STRENGTH"      /* see ciphers(1) */
 386
 387 int CtdlIPCNoop(CtdlIPC *ipc);
 388 int CtdlIPCEcho(CtdlIPC *ipc, const char *arg, char *cret);
 389 int CtdlIPCQuit(CtdlIPC *ipc);
 390 int CtdlIPCLogout(CtdlIPC *ipc);
 391 int CtdlIPCTryLogin(CtdlIPC *ipc, const char *username, char *cret);
 392 int CtdlIPCTryPassword(CtdlIPC *ipc, const char *passwd, char *cret);
 393 int CtdlIPCTryApopPassword(CtdlIPC *ipc, const char *response, char *cret);
 394 int CtdlIPCCreateUser(CtdlIPC *ipc, const char *username, int selfservice,
 395                 char *cret);
 396 int CtdlIPCChangePassword(CtdlIPC *ipc, const char *passwd, char *cret);
 397 int CtdlIPCKnownRooms(CtdlIPC *ipc, enum RoomList which, int floor,
 398                 struct march **listing, char *cret);
 399 int CtdlIPCGetConfig(CtdlIPC *ipc, struct ctdluser **uret, char *cret);
 400 int CtdlIPCSetConfig(CtdlIPC *ipc, struct ctdluser *uret, char *cret);
 401 int CtdlIPCGotoRoom(CtdlIPC *ipc, const char *room, const char *passwd,
 402                 struct ctdlipcroom **rret, char *cret);
 403 int CtdlIPCGetMessages(CtdlIPC *ipc, enum MessageList which, int whicharg,
 404                 const char *mtemplate, unsigned long **mret, char *cret);
 405 int CtdlIPCGetSingleMessage(CtdlIPC *ipc, long msgnum, int headers, int as_mime,
 406                 struct ctdlipcmessage **mret, char *cret);
 407 int CtdlIPCWhoKnowsRoom(CtdlIPC *ipc, char **listing, char *cret);
 408 int CtdlIPCServerInfo(CtdlIPC *ipc, char *cret);
 409 /* int CtdlIPCReadDirectory(CtdlIPC *ipc, struct ctdlipcfile **files, char *cret); */
 410 int CtdlIPCReadDirectory(CtdlIPC *ipc, char **listing, char *cret);
 411 int CtdlIPCSetLastRead(CtdlIPC *ipc, long msgnum, char *cret);
 412 int CtdlIPCInviteUserToRoom(CtdlIPC *ipc, const char *username, char *cret);
 413 int CtdlIPCKickoutUserFromRoom(CtdlIPC *ipc, const char *username, char *cret);
 414 int CtdlIPCGetRoomAttributes(CtdlIPC *ipc, struct ctdlroom **qret, char *cret);
 415 int CtdlIPCSetRoomAttributes(CtdlIPC *ipc, int forget, struct ctdlroom *qret,
 416                 char *cret);
 417 int CtdlIPCGetRoomAide(CtdlIPC *ipc, char *cret);
 418 int CtdlIPCSetRoomAide(CtdlIPC *ipc, const char *username, char *cret);
 419 int CtdlIPCPostMessage(CtdlIPC *ipc, int flag, int *subject_required,
 420                                            struct ctdlipcmessage *mr,
 421                                            char *cret);
 422 int CtdlIPCRoomInfo(CtdlIPC *ipc, char **iret, char *cret);
 423 int CtdlIPCDeleteMessage(CtdlIPC *ipc, long msgnum, char *cret);
 424 int CtdlIPCMoveMessage(CtdlIPC *ipc, int copy, long msgnum,
 425                 const char *destroom, char *cret);
 426 int CtdlIPCDeleteRoom(CtdlIPC *ipc, int for_real, char *cret);
 427 int CtdlIPCCreateRoom(CtdlIPC *ipc, int for_real, const char *roomname,
 428                 int type, const char *password, int floor, char *cret);
 429 int CtdlIPCForgetRoom(CtdlIPC *ipc, char *cret);
 430 int CtdlIPCSystemMessage(CtdlIPC *ipc, const char *message, char **mret,
 431                 char *cret);
 432 int CtdlIPCNextUnvalidatedUser(CtdlIPC *ipc, char *cret);
 433 int CtdlIPCGetUserRegistration(CtdlIPC *ipc, const char *username, char **rret,
 434                 char *cret);
 435 int CtdlIPCValidateUser(CtdlIPC *ipc, const char *username, int axlevel,
 436                 char *cret);
 437 int CtdlIPCSetRoomInfo(CtdlIPC *ipc, int for_real, const char *info,
 438                 char *cret);
 439 int CtdlIPCUserListing(CtdlIPC *ipc, char *searchstring, char **list, char *cret);
 440 int CtdlIPCSetRegistration(CtdlIPC *ipc, const char *info, char *cret);
 441 int CtdlIPCMiscCheck(CtdlIPC *ipc, struct ctdlipcmisc *chek, char *cret);
 442 int CtdlIPCDeleteFile(CtdlIPC *ipc, const char *filename, char *cret);
 443 int CtdlIPCMoveFile(CtdlIPC *ipc, const char *filename, const char *destroom, char *cret);
 444 int CtdlIPCNetSendFile(CtdlIPC *ipc, const char *filename, const char *destnode, char *cret);
 445 int CtdlIPCOnlineUsers(CtdlIPC *ipc, char **listing, time_t *stamp, char *cret);
 446 int CtdlIPCFileDownload(CtdlIPC *ipc, const char *filename, void **buf,
 447                 size_t resume,
 448                 void (*progress_gauge_callback)(CtdlIPC*, unsigned long, unsigned long),
 449                 char *cret);
 450 int CtdlIPCAttachmentDownload(CtdlIPC *ipc, long msgnum, const char *part,
 451                 void **buf,
 452                 void (*progress_gauge_callback)(CtdlIPC*, unsigned long, unsigned long),
 453                 char *cret);
 454 int CtdlIPCImageDownload(CtdlIPC *ipc, const char *filename, void **buf,
 455                 void (*progress_gauge_callback)(CtdlIPC*, unsigned long, unsigned long),
 456                 char *cret);
 457 int CtdlIPCFileUpload(CtdlIPC *ipc, const char *save_as, const char *comment,
 458                 const char *path,
 459                 void (*progress_gauge_callback)(CtdlIPC*, unsigned long, unsigned long),
 460                 char *cret);
 461 int CtdlIPCImageUpload(CtdlIPC *ipc, int for_real, const char *path,
 462                 const char *save_as,
 463                 void (*progress_gauge_callback)(CtdlIPC*, unsigned long, unsigned long),
 464                 char *cret);
 465 int CtdlIPCQueryUsername(CtdlIPC *ipc, const char *username, char *cret);
 466 int CtdlIPCFloorListing(CtdlIPC *ipc, char **listing, char *cret);
 467 int CtdlIPCCreateFloor(CtdlIPC *ipc, int for_real, const char *name, char *cret);
 468 int CtdlIPCDeleteFloor(CtdlIPC *ipc, int for_real, int floornum, char *cret);
 469 int CtdlIPCEditFloor(CtdlIPC *ipc, int floornum, const char *floorname, char *cret);
 470 int CtdlIPCIdentifySoftware(CtdlIPC *ipc, int developerid, int clientid,
 471                 int revision, const char *software_name, const char *hostname,
 472                 char *cret);
 473 int CtdlIPCSendInstantMessage(CtdlIPC *ipc, const char *username, const char *text, char *cret);
 474 int CtdlIPCGetInstantMessage(CtdlIPC *ipc, char **listing, char *cret);
 475 int CtdlIPCEnableInstantMessageReceipt(CtdlIPC *ipc, int mode, char *cret);
 476 int CtdlIPCSetBio(CtdlIPC *ipc, char *bio, char *cret);
 477 int CtdlIPCGetBio(CtdlIPC *ipc, const char *username, char **listing, char *cret);
 478 int CtdlIPCListUsersWithBios(CtdlIPC *ipc, char **listing, char *cret);
 479 int CtdlIPCStealthMode(CtdlIPC *ipc, int mode, char *cret);
 480 int CtdlIPCTerminateSession(CtdlIPC *ipc, int sid, char *cret);
 481 int CtdlIPCTerminateServerNow(CtdlIPC *ipc, char *cret);
 482 int CtdlIPCTerminateServerScheduled(CtdlIPC *ipc, int mode, char *cret);
 483 int CtdlIPCEnterSystemMessage(CtdlIPC *ipc, const char *filename, const char *text, char *cret);
 484 time_t CtdlIPCServerTime(CtdlIPC *ipc, char *crert);
 485 int CtdlIPCAideGetUserParameters(CtdlIPC *ipc, const char *who, struct ctdluser **uret, char *cret);
 486 int CtdlIPCAideGetEmailAddresses(CtdlIPC *ipc, const char *who, char *, char *cret);
 487 int CtdlIPCAideSetUserParameters(CtdlIPC *ipc, const struct ctdluser *uret, char *cret);
 488 int CtdlIPCAideSetEmailAddresses(CtdlIPC *ipc, const char *who, char *emailaddrs, char *cret);
 489 int CtdlIPCRenameUser(CtdlIPC *ipc, char *oldname, char *newname, char *cret);
 490 int CtdlIPCGetMessageExpirationPolicy(CtdlIPC *ipc, GPEXWhichPolicy which, struct ExpirePolicy **policy, char *cret);
 491 int CtdlIPCSetMessageExpirationPolicy(CtdlIPC *ipc, int which, struct ExpirePolicy *policy, char *cret);
 492 int CtdlIPCGetSystemConfig(CtdlIPC *ipc, char **listing, char *cret);
 493 int CtdlIPCSetSystemConfig(CtdlIPC *ipc, const char *listing, char *cret);
 494 int CtdlIPCGetSystemConfigByType(CtdlIPC *ipc, const char *mimetype, char **listing, char *cret);
 495 int CtdlIPCSetSystemConfigByType(CtdlIPC *ipc, const char *mimetype, const char *listing, char *cret);
 496 int CtdlIPCGetRoomNetworkConfig(CtdlIPC *ipc, char **listing, char *cret);
 497 int CtdlIPCSetRoomNetworkConfig(CtdlIPC *ipc, const char *listing, char *cret);
 498 int CtdlIPCRequestClientLogout(CtdlIPC *ipc, int session, char *cret);
 499 int CtdlIPCSetMessageSeen(CtdlIPC *ipc, long msgnum, int seen, char *cret);
 500 int CtdlIPCStartEncryption(CtdlIPC *ipc, char *cret);
 501 int CtdlIPCDirectoryLookup(CtdlIPC *ipc, const char *address, char *cret);
 502 int CtdlIPCSpecifyPreferredFormats(CtdlIPC *ipc, char *cret, char *formats);
 503 int CtdlIPCInternalProgram(CtdlIPC *ipc, int secret, char *cret);
 504
 505 /* ************************************************************************** */
 506 /*             Stuff below this line is not for public consumption            */
 507 /* ************************************************************************** */
 508
 509 char *CtdlIPCReadListing(CtdlIPC *ipc, char *dest);
 510 int CtdlIPCSendListing(CtdlIPC *ipc, const char *listing);
 511 size_t CtdlIPCPartialRead(CtdlIPC *ipc, void **buf, size_t offset, size_t bytes, char *cret);
 512 int CtdlIPCEndUpload(CtdlIPC *ipc, int discard, char *cret);
 513 int CtdlIPCWriteUpload(CtdlIPC *ipc, FILE *uploadFP,
 514                 void (*progress_gauge_callback)(CtdlIPC*, unsigned long, unsigned long),
 515                 char *cret);
 516 int CtdlIPCEndDownload(CtdlIPC *ipc, char *cret);
 517 int CtdlIPCReadDownload(CtdlIPC *ipc, void **buf, size_t bytes, size_t resume,
 518                 void (*progress_gauge_callback)(CtdlIPC*, unsigned long, unsigned long),
 519                 char *cret);
 520 int CtdlIPCHighSpeedReadDownload(CtdlIPC *ipc, void **buf, size_t bytes,
 521                 size_t resume,
 522                 void (*progress_gauge_callback)(CtdlIPC*, unsigned long, unsigned long),
 523                 char *cret);
 524 int CtdlIPCGenericCommand(CtdlIPC *ipc, const char *command,
 525                 const char *to_send, size_t bytes_to_send, char **to_receive,
 526                 size_t *bytes_to_receive, char *proto_response);
 527
 528 /* Internals */
 529 int starttls(CtdlIPC *ipc);
 530 void setCryptoStatusHook(void (*hook)(char *s));
 531 void CtdlIPC_SetNetworkStatusCallback(CtdlIPC *ipc, void (*hook)(int state));
 532 /* This is all Ford's doing.  FIXME: figure out what it's doing */
 533 extern int (*error_printf)(char *s, ...);
 534 void setIPCDeathHook(void (*hook)(void));
 535 void setIPCErrorPrintf(int (*func)(char *s, ...));
 536 void connection_died(CtdlIPC* ipc, int using_ssl);
 537 int CtdlIPC_getsockfd(CtdlIPC* ipc);
 538 char CtdlIPC_get(CtdlIPC* ipc);
 539 void CtdlIPC_lock(CtdlIPC *ipc);
 540 void CtdlIPC_unlock(CtdlIPC *ipc);
 541 char *libcitadelclient_version_string(void);
 542 void chatmode(CtdlIPC *ipc);
 543 void page_user(CtdlIPC *ipc);
 544 void quiet_mode(CtdlIPC *ipc);
 545 void stealth_mode(CtdlIPC *ipc);
 546 extern char last_paged[];
 547
 548 void determine_pwfilename(char *pwfile, size_t n);
 549 void get_stored_password(
 550                 char *host,
 551                 char *port,
 552                 char *username,
 553                 char *password);
 554 void set_stored_password(
 555                 char *host,
 556                 char *port,
 557                 char *username,
 558                 char *password);
 559 void offer_to_remember_password(CtdlIPC *ipc,
 560                 char *host,
 561                 char *port,
 562                 char *username,
 563                 char *password);
 564
 565 void load_command_set(void);
 566 void stty_ctdl(int cmd);
 567 void newprompt(char *prompt, char *str, int len);
 568 void strprompt(char *prompt, char *str, int len);
 569 int boolprompt(char *prompt, int prev_val);
 570 int intprompt(char *prompt, int ival, int imin, int imax);
 571 int fmout(int width, FILE *fpin, char *text, FILE *fpout, int subst);
 572 int getcmd(CtdlIPC *ipc, char *argbuf);
 573 void display_help(CtdlIPC *ipc, char *name);
 574 void color(int colornum);
 575 void cls(int colornum);
 576 void send_ansi_detect(void);
 577 void look_for_ansi(void);
 578 int inkey(void);
 579 void set_keepalives(int s);
 580 extern int enable_color;
 581 int yesno(void);
 582 int yesno_d(int d);
 583 void keyopt(char *);
 584 char keymenu(char *menuprompt, char *menustring);
 585 void async_ka_start(void);
 586 void async_ka_end(void);
 587 int checkpagin(int lp, unsigned int pagin, unsigned int height);
 588 char was_a_key_pressed(void);
 589
 590 #ifdef __GNUC__
 591 void pprintf(const char *format, ...) __attribute__((__format__(__printf__,1,2)));
 592 #else
 593 void pprintf(const char *format, ...);
 594 #endif
 595
 596
 597 extern char rc_url_cmd[SIZ];
 598 extern char rc_open_cmd[SIZ];
 599 extern char rc_gotmail_cmd[SIZ];
 600 extern int lines_printed;
 601 extern int rc_remember_passwords;
 602
 603 #ifndef MD5_H
 604 #define MD5_H
 605
 606 struct MD5Context {
 607         uint32_t buf[4];
 608         uint32_t bits[2];
 609         uint32_t in[16];
 610 };
 611
 612 void MD5Init(struct MD5Context *context);
 613 void MD5Update(struct MD5Context *context, unsigned char const *buf,
 614                unsigned len);
 615 void MD5Final(unsigned char digest[16], struct MD5Context *context);
 616 void MD5Transform(uint32_t buf[4], uint32_t const in[16]);
 617 char *make_apop_string(char *realpass, char *nonce, char *buffer, size_t n);
 618
 619 /*
 620  * This is needed to make RSAREF happy on some MS-DOS compilers.
 621  */
 622 #ifndef HAVE_OPENSSL
 623 typedef struct MD5Context MD5_CTX;
 624 #endif
 625
 626 #define MD5_DIGEST_LEN          16
 627 #define MD5_HEXSTRING_SIZE      33
 628
 629 #endif /* !MD5_H */
 630
 631
 632 #define MAXURLS         50      /* Max embedded URL's per message */
 633 extern int num_urls;
 634 extern char urls[MAXURLS][SIZ];
 635
 636 int ka_system(char *shc);
 637 int entmsg(CtdlIPC *ipc, int is_reply, int c, int masquerade);
 638 void readmsgs(CtdlIPC *ipc, enum MessageList c, enum MessageDirection rdir, int q);
 639 void edit_system_message(CtdlIPC *ipc, char *which_message);
 640 pid_t ka_wait(int *kstatus);
 641 void list_urls(CtdlIPC *ipc);
 642 int client_make_message(CtdlIPC *ipc,
 643                         char *filename,         /* temporary file name */
 644                         char *recipient,        /* NULL if it's not mail */
 645                         int anon_type,          /* see MES_ types in header file */
 646                         int format_type,
 647                         int mode,
 648                         char *subject,
 649                         int subject_required
 650 );
 651 void citedit(FILE *);
 652 char *load_message_from_file(FILE *src);
 653 int file_checksum(char *filename);
 654 void listzrooms(CtdlIPC *ipc);
 655 void readinfo(CtdlIPC *ipc);
 656 void forget(CtdlIPC *ipc);
 657 void entroom(CtdlIPC *ipc);
 658 void killroom(CtdlIPC *ipc);
 659 void invite(CtdlIPC *ipc);
 660 void kickout(CtdlIPC *ipc);
 661 void editthisroom(CtdlIPC *ipc);
 662 void roomdir(CtdlIPC *ipc);
 663 void download(CtdlIPC *ipc, int proto);
 664 void ungoto(CtdlIPC *ipc);
 665 void dotungoto(CtdlIPC *ipc, char *towhere);
 666 void whoknows(CtdlIPC *ipc);
 667 void enterinfo(CtdlIPC *ipc);
 668 void knrooms(CtdlIPC *ipc, int kn_floor_mode);
 669 void dotknown(CtdlIPC *ipc, int what, char *match);
 670 void load_floorlist(CtdlIPC *ipc);
 671 void create_floor(CtdlIPC *ipc);
 672 void edit_floor(CtdlIPC *ipc);
 673 void kill_floor(CtdlIPC *ipc);
 674 void enter_bio(CtdlIPC *ipc);
 675 int save_buffer(void *file, size_t filelen, const char *pathname);
 676 void destination_directory(char *dest, const char *supplied_filename);
 677 void do_edit(CtdlIPC *ipc, char *desc, char *read_cmd, char *check_cmd, char *write_cmd);
 678
 679
 680 /*
 681  * This struct holds a list of rooms for client display.
 682  * (oooh, a tree!)
 683  */
 684 struct ctdlroomlisting {
 685         struct ctdlroomlisting *lnext;
 686         struct ctdlroomlisting *rnext;
 687         char rlname[ROOMNAMELEN];
 688         unsigned rlflags;
 689         int rlfloor;
 690         int rlorder;
 691         };
 692
 693
 694 enum {
 695         LISTRMS_NEW_ONLY,
 696         LISTRMS_OLD_ONLY,
 697         LISTRMS_ALL
 698 };
 699
 700
 701 void updatels(CtdlIPC *ipc);
 702 void updatelsa(CtdlIPC *ipc);
 703 void movefile(CtdlIPC *ipc);
 704 void deletefile(CtdlIPC *ipc);
 705 void netsendfile(CtdlIPC *ipc);
 706 void entregis(CtdlIPC *ipc);
 707 void subshell(void);
 708 void upload(CtdlIPC *ipc, int c);
 709 void cli_upload(CtdlIPC *ipc);
 710 void validate(CtdlIPC *ipc);
 711 void read_bio(CtdlIPC *ipc);
 712 void cli_image_upload(CtdlIPC *ipc, char *keyname);
 713 int room_prompt(unsigned int qrflags);
 714 int val_user(CtdlIPC *ipc, char *user, int do_validate);
 715
 716 void edituser(CtdlIPC *ipc, int cmd);
 717 void interr(int errnum);
 718 int struncmp(char *lstr, char *rstr, int len);
 719 int pattern(char *search, char *patn);
 720 void enter_config(CtdlIPC* ipc, int mode);
 721 void locate_host(CtdlIPC* ipc, char *hbuf);
 722 void misc_server_cmd(CtdlIPC *ipc, char *cmd);
 723 int nukedir(char *dirname);
 724 void strproc(char *string);
 725 void back(int spaces);
 726 void progress(CtdlIPC* ipc, unsigned long curr, unsigned long cmax);
 727 int set_attr(CtdlIPC *ipc, unsigned int sval, char *prompt, unsigned int sbit, int backwards);
 728
 729 void screen_new(void);
 730 int scr_printf(char *fmt, ...);
 731 #define SCR_NOBLOCK 0
 732 #define SCR_BLOCK -1
 733 int scr_getc(int delay);
 734 int scr_putc(int c);
 735 void scr_flush(void);
 736 int scr_blockread(void);
 737 sighandler_t scr_winch(int signum);
 738 void wait_indicator(int state);
 739 void ctdl_beep(void);
 740 void scr_wait_indicator(int);
 741 extern char status_line[];
 742 extern void check_screen_dims(void);
 743 extern int screenwidth;
 744 extern int screenheight;
 745 void do_internet_configuration(CtdlIPC *ipc);
 746 void network_config_management(CtdlIPC *ipc, char *entrytype, char *comment);
 747 void do_pop3client_configuration(CtdlIPC *ipc);
 748 void do_rssclient_configuration(CtdlIPC *ipc);
 749 void do_system_configuration(CtdlIPC *ipc);
 750 extern char editor_path[PATH_MAX];
 751 extern int enable_status_line;