webcit/webcit.h

   1
   2 /* $Id$ */
   3
   4 #include "sysdep.h"
   5
   6
   7 #include <sys/select.h>
   8
   9 #include <ctype.h>
  10 #include <stdlib.h>
  11 #ifdef HAVE_UNISTD_H
  12 #include <unistd.h>
  13 #endif
  14 #include <stdio.h>
  15 #ifdef HAVE_FCNTL_H
  16 #include <fcntl.h>
  17 #endif
  18 #include <signal.h>
  19 #include <sys/types.h>
  20 #include <sys/wait.h>
  21 #include <sys/socket.h>
  22 #ifdef HAVE_SYS_TIME_H
  23 #include <sys/time.h>
  24 #endif
  25 #include <sys/stat.h>
  26 #ifdef HAVE_LIMITS_H
  27 #include <limits.h>
  28 #endif
  29 #include <netinet/in.h>
  30 #include <arpa/inet.h>
  31 #include <sys/un.h>
  32 #include <netdb.h>
  33 #include <sys/poll.h>
  34 #include <string.h>
  35 #include <pwd.h>
  36 #include <errno.h>
  37 #include <stdarg.h>
  38 #include <pthread.h>
  39 #include <signal.h>
  40 #include <sys/utsname.h>
  41
  42 #include <libcitadel.h>
  43
  44 #ifndef INADDR_NONE
  45 #define INADDR_NONE 0xffffffff
  46 #endif
  47
  48 #ifdef HAVE_ICONV
  49 #include <iconv.h>
  50 #endif
  51
  52 #ifdef ENABLE_NLS
  53 #ifdef HAVE_XLOCALE_H
  54 #include <xlocale.h>
  55 #endif
  56 #include <libintl.h>
  57 #include <locale.h>
  58 #define _(string)       gettext(string)
  59 #else
  60 #define _(string)       (string)
  61 #endif
  62
  63 #define IsEmptyStr(a) ((a)[0] == '\0')
  64 /*
  65  * Uncomment to dump an HTTP trace to stderr
  66 #define HTTP_TRACING 1
  67  */
  68
  69 #ifdef HTTP_TRACING
  70 #undef HAVE_ZLIB_H
  71 #undef HAVE_ZLIB
  72 #endif
  73
  74 #ifdef HAVE_ZLIB_H
  75 #include <zlib.h>
  76 #endif
  77
  78 #include <libical/ical.h>
  79
  80 #undef PACKAGE
  81 #undef VERSION
  82 #undef PACKAGE_NAME
  83 #undef PACKAGE_STRING
  84 #undef PACKAGE_TARNAME
  85 #undef PACKAGE_VERSION
  86 #undef PACKAGE_BUGREPORT
  87 #include "sysdep.h"
  88
  89 #include "subst.h"
  90 #include "wc_gettext.h"
  91 #include "messages.h"
  92 #include "paramhandling.h"
  93 #include "preferences.h"
  94
  95
  96 #ifdef HAVE_OPENSSL
  97 /* Work around RedHat's b0rken OpenSSL includes */
  98 #define OPENSSL_NO_KRB5
  99 #include <openssl/ssl.h>
 100 #include <openssl/err.h>
 101 #include <openssl/rand.h>
 102 #endif
 103
 104 #define CALENDAR_ROOM_NAME      "Calendar"
 105 #define PRODID "-//Citadel//NONSGML Citadel Calendar//EN"
 106
 107 #define SIZ                     4096            /* generic buffer size */
 108
 109 #define TRACE fprintf(stderr, "Checkpoint: %s, %d\n", __FILE__, __LINE__)
 110
 111 #define SLEEPING                180             /* TCP connection timeout */
 112 #define WEBCIT_TIMEOUT          900             /* WebCit session timeout */
 113 #define PORT_NUM                2000            /* port number to listen on */
 114 #define DEVELOPER_ID            0
 115 #define CLIENT_ID               4
 116 #define CLIENT_VERSION          760             /* This version of WebCit */
 117 #define MINIMUM_CIT_VERSION     744             /* min required Citadel ver */
 118 #define LIBCITADEL_MIN          744             /* min required libcitadel ver */
 119 #define DEFAULT_HOST            "localhost"     /* Default Citadel server */
 120 #define DEFAULT_PORT            "504"
 121 #define TARGET                  "webcit01"      /* Target for inline URL's */
 122 #define HOUSEKEEPING            15              /* Housekeeping frequency */
 123 #define MIN_WORKER_THREADS      5
 124 #define MAX_WORKER_THREADS      250
 125 #define LISTEN_QUEUE_LENGTH     100             /* listen() backlog queue */
 126
 127 #define USERCONFIGROOM          "My Citadel Config"
 128 #define DEFAULT_MAXMSGS         20
 129
 130
 131 #ifdef LIBCITADEL_VERSION_NUMBER
 132 #if LIBCITADEL_VERSION_NUMBER < LIBCITADEL_MIN
 133 #error libcitadel is too old.  Please upgrade it before continuing.
 134 #endif
 135 #endif
 136
 137
 138 /*
 139  * Room flags (from Citadel)
 140  *
 141  * bucket one...
 142  */
 143 #define QR_PERMANENT    1               /* Room does not purge          */
 144 #define QR_INUSE        2               /* Set if in use, clear if avail        */
 145 #define QR_PRIVATE      4               /* Set for any type of private room     */
 146 #define QR_PASSWORDED   8               /* Set if there's a password too        */
 147 #define QR_GUESSNAME    16              /* Set if it's a guessname room */
 148 #define QR_DIRECTORY    32              /* Directory room                       */
 149 #define QR_UPLOAD       64              /* Allowed to upload                    */
 150 #define QR_DOWNLOAD     128             /* Allowed to download          */
 151 #define QR_VISDIR       256             /* Visible directory                    */
 152 #define QR_ANONONLY     512             /* Anonymous-Only room          */
 153 #define QR_ANONOPT      1024            /* Anonymous-Option room                */
 154 #define QR_NETWORK      2048            /* Shared network room          */
 155 #define QR_PREFONLY     4096            /* Preferred status needed to enter     */
 156 #define QR_READONLY     8192            /* Aide status required to post */
 157 #define QR_MAILBOX      16384           /* Set if this is a private mailbox     */
 158
 159 /*
 160  * bucket two...
 161  */
 162 #define QR2_SYSTEM      1               /* System room; hide by default */
 163 #define QR2_SELFLIST    2               /* Self-service mailing list mgmt       */
 164 #define QR2_COLLABDEL   4               /* Anyone who can post can also delete*/
 165 #define QR2_SUBJECTREQ  8               /* Subject strongly recommended */
 166 #define QR2_SMTP_PUBLIC 16              /* smtp public postable room */
 167 #define QR2_MODERATED   32              /* Listservice aide has to permit posts  */
 168
 169 /*
 170  * user/room access
 171  */
 172 #define UA_KNOWN        2
 173 #define UA_GOTOALLOWED  4
 174 #define UA_HASNEWMSGS   8
 175 #define UA_ZAPPED       16
 176
 177
 178 /*
 179  * User flags (from Citadel)
 180  */
 181 #define US_NEEDVALID    1               /* User needs to be validated           */
 182 #define US_PERM         4               /* Permanent user                       */
 183 #define US_LASTOLD      16              /* Print last old message with new      */
 184 #define US_EXPERT       32              /* Experienced user                     */
 185 #define US_UNLISTED     64              /* Unlisted userlog entry               */
 186 #define US_NOPROMPT     128             /* Don't prompt after each message      */
 187 #define US_PROMPTCTL    256             /* <N>ext & <S>top work at prompt       */
 188 #define US_DISAPPEAR    512             /* Use "disappearing msg prompts"       */
 189 #define US_REGIS        1024            /* Registered user                      */
 190 #define US_PAGINATOR    2048            /* Pause after each screen of text      */
 191 #define US_INTERNET     4096            /* Internet mail privileges             */
 192 #define US_FLOORS       8192            /* User wants to see floors             */
 193 #define US_COLOR        16384           /* User wants ANSI color support        */
 194 #define US_USER_SET     (US_LASTOLD | US_EXPERT | US_UNLISTED | \
 195                         US_NOPROMPT | US_DISAPPEAR | US_PAGINATOR | \
 196                         US_FLOORS | US_COLOR | US_PROMPTCTL )
 197
 198
 199 #define MAJORCODE(a) (((int)(a / 100) ) * 100)
 200
 201 #define LISTING_FOLLOWS 100
 202 #define CIT_OK          200
 203 #define MORE_DATA       300
 204 #define SEND_LISTING    400
 205 #define ERROR           500
 206 #define BINARY_FOLLOWS  600
 207 #define SEND_BINARY     700
 208 #define START_CHAT_MODE 800
 209 #define ASYNC_MSG       900
 210
 211 #define MINORCODE(a) (a % 100)
 212 #define ASYNC_GEXP                      02
 213 #define INTERNAL_ERROR                  10
 214 #define TOO_BIG                         11
 215 #define ILLEGAL_VALUE                   12
 216 #define NOT_LOGGED_IN                   20
 217 #define CMD_NOT_SUPPORTED               30
 218 #define SERVER_SHUTTING_DOWN            31
 219 #define PASSWORD_REQUIRED               40
 220 #define ALREADY_LOGGED_IN               41
 221 #define USERNAME_REQUIRED               42
 222 #define HIGHER_ACCESS_REQUIRED          50
 223 #define MAX_SESSIONS_EXCEEDED           51
 224 #define RESOURCE_BUSY                   52
 225 #define RESOURCE_NOT_OPEN               53
 226 #define NOT_HERE                        60
 227 #define INVALID_FLOOR_OPERATION         61
 228 #define NO_SUCH_USER                    70
 229 #define FILE_NOT_FOUND                  71
 230 #define ROOM_NOT_FOUND                  72
 231 #define NO_SUCH_SYSTEM                  73
 232 #define ALREADY_EXISTS                  74
 233 #define MESSAGE_NOT_FOUND               75
 234 /*
 235  * NLI is the string that shows up in a who's online listing for sessions
 236  * that are active, but for which no user has yet authenticated.
 237  */
 238 #define NLI     "(not logged in)"
 239
 240
 241 /*
 242  * \brief       Linked list of session variables encoded in an x-www-urlencoded content type
 243  */
 244 typedef struct urlcontent urlcontent;
 245 struct urlcontent {
 246         char url_key[32];          /* the variable name */
 247         StrBuf *url_data;            /* its value */
 248 };
 249
 250 /*
 251  * \brief information about us ???
 252  */
 253 typedef struct _serv_info {
 254         int serv_pid;                   /* Process ID of the Citadel server */
 255         StrBuf *serv_nodename;          /* Node name of the Citadel server */
 256         StrBuf *serv_humannode;         /* human readable node name of the Citadel server */
 257         StrBuf *serv_fqdn;              /* fully quallified Domain Name (such as uncensored.citadel.org) */
 258         StrBuf *serv_software;          /* What version does our connected citadel server use */
 259         int serv_rev_level;             /* Whats the citadel server revision */
 260         StrBuf *serv_bbs_city;          /* Geographic location of the Citadel server */
 261         StrBuf *serv_sysadm;            /* Name of system administrator */
 262         StrBuf *serv_moreprompt;        /* Whats the commandline textprompt */
 263         int serv_ok_floors;             /* nonzero == server supports floors */
 264         int serv_supports_ldap;         /* is the server linked against an ldap tree for adresses? */
 265         int serv_newuser_disabled;      /* Has the server disabled self-service new user creation? */
 266         StrBuf *serv_default_cal_zone;  /* Default timezone for unspecified calendar items */
 267         int serv_supports_sieve;        /* Does the server support Sieve mail filtering? */
 268         int serv_fulltext_enabled;      /* Does the server have the full text index enabled? */
 269         StrBuf *serv_svn_revision;      /* SVN revision of the server */
 270         int serv_supports_openid;       /* Does the server support authentication via OpenID? */
 271 } ServInfo;
 272
 273
 274
 275 /*
 276  * \brief This struct holds a list of rooms for \\\<G\\\>oto operations.
 277  */
 278 struct march {
 279         struct march *next;       /* pointer to next in linked list */
 280         char march_name[128];     /* name of room */
 281         int march_floor;          /* floor number of room */
 282         int march_order;          /* sequence in which we are to visit this room */
 283 };
 284
 285 /* *
 286  * \brief       This struct holds a list of rooms for client display.
 287  *              It is a binary tree.
 288  */
 289 struct roomlisting {
 290         struct roomlisting *lnext;      /* pointer to 'left' tree node */
 291         struct roomlisting *rnext;      /* pointer to 'right' tree node */
 292         char rlname[128];               /* name of room */
 293         unsigned rlflags;               /* room flags */
 294         int rlfloor;                    /* the floor it resides on */
 295         int rlorder;                    /* room listing order */
 296 };
 297
 298
 299
 300
 301
 302
 303
 304 /**
 305  * \brief  Data structure for roomlist-to-folderlist conversion
 306  */
 307 struct folder {
 308         int floor;      /* which floor is it on */
 309         char room[SIZ]; /* which roomname ??? */
 310         char name[SIZ]; /* which is its own name??? */
 311         int hasnewmsgs; /* are there unread messages inside */
 312         int is_mailbox; /* is it a mailbox?  */
 313         int selectable; /* can we select it ??? */
 314         int view;       /* whats its default view? inbox/calendar.... */
 315         int num_rooms;  /* If this is a floor, how many rooms does it have */
 316 };
 317
 318 typedef struct _disp_cal {
 319         icalcomponent *cal;             /* cal items for display */
 320         long cal_msgnum;                /* cal msgids for display */
 321         char *from;                     /* owner of this component */
 322         int unread;                     /* already seen by the user? */
 323
 324         time_t event_start;
 325         time_t event_end;
 326
 327         int multi_day_event;
 328         int is_repeat;
 329         icalcomponent *SortBy;          /* cal items for display */
 330         icalproperty_status Status;
 331 } disp_cal;
 332
 333 typedef struct _IcalEnumMap {
 334         const char *Name;
 335         long NameLen;
 336         icalproperty_kind map;
 337 } IcalEnumMap;
 338
 339 /*
 340  * Address book entry (keep it short and sweet, it's just a quickie lookup
 341  * which we can use to get to the real meat and bones later)
 342  */
 343 typedef struct _addrbookent {
 344         char ab_name[64]; /**< name string */
 345         long ab_msgnum;   /**< message number of address book entry */
 346 } addrbookent;
 347
 348
 349 #define AJAX (1<<0)
 350 #define ANONYMOUS (1<<1)
 351 #define NEED_URL (1<<2)
 352 #define XHTTP_COMMANDS (1<<3)
 353 #define BOGUS (1<<4)
 354 #define URLNAMESPACE (1<<4)
 355 #define LOGCHATTY (1<<5)
 356 #define COOKIEUNNEEDED (1<<6)
 357 #define ISSTATIC (1<<7)
 358 #define FORCE_SESSIONCLOSE (1<<8)
 359
 360
 361 typedef void (*WebcitHandlerFunc)(void);
 362 typedef struct  _WebcitHandler{
 363         WebcitHandlerFunc F;
 364         long Flags;
 365         StrBuf *Name;
 366 } WebcitHandler;
 367 void WebcitAddUrlHandler(const char * UrlString, long UrlSLen, WebcitHandlerFunc F, long Flags);
 368
 369 typedef struct _headereval {
 370         ExamineMsgHeaderFunc evaluator;
 371         int Type;
 372 } headereval;
 373
 374
 375 struct attach_link {
 376         char partnum[32];
 377         char html[1024];
 378 };
 379
 380
 381 enum {
 382         eUp,
 383         eDown,
 384         eNone
 385 };
 386
 387 enum {
 388         eGET,
 389         ePOST,
 390         eOPTIONS,
 391         ePROPFIND,
 392         ePUT,
 393         eDELETE,
 394         eHEAD,
 395         eMOVE,
 396         eCOPY,
 397         eNONE
 398 };
 399 const char *ReqStrs[eNONE];
 400
 401 #define NO_AUTH 0
 402 #define AUTH_COOKIE 1
 403 #define AUTH_BASIC 2
 404
 405
 406
 407 typedef struct _HdrRefs {
 408         long eReqType;                          /**< eGET, ePOST.... */
 409         int desired_session;
 410         int SessionKey;
 411
 412         int got_auth;
 413         int DontNeedAuth;
 414         long ContentLength;
 415         time_t if_modified_since;
 416         int gzip_ok;                            /**< Nonzero if Accept-encoding: gzip */
 417
 418         /* these are references into Hdr->HTTPHeaders, so we don't need to free them. */
 419         StrBuf *ContentType;
 420         StrBuf *RawCookie;
 421         StrBuf *ReqLine;
 422         StrBuf *http_host;                      /**< HTTP Host: header */
 423         StrBuf *browser_host;
 424         StrBuf *user_agent;
 425         StrBuf *plainauth;
 426
 427
 428         const WebcitHandler *Handler;
 429 } HdrRefs;
 430
 431 typedef struct _ParsedHttpHdrs {
 432         int http_sock;                          /**< HTTP server socket */
 433         const char *Pos;
 434         StrBuf *ReadBuf;
 435
 436
 437
 438         StrBuf *c_username;
 439         StrBuf *c_password;
 440         StrBuf *c_roomname;
 441         StrBuf *c_language;
 442         StrBuf *this_page;                      /**< URL of current page */
 443         StrBuf *PlainArgs; /*TODO: freeme*/
 444
 445         HashList *urlstrings;                   /**< variables passed to webcit in a URL */
 446         HashList *HTTPHeaders;                  /**< the headers the client sent us */
 447         int nWildfireHeaders;                   /**< how many wildfire headers did we already send? */
 448
 449         HdrRefs HR;
 450 } ParsedHttpHdrs;
 451
 452
 453 /*
 454  * One of these is kept for each active Citadel session.
 455  * HTTP transactions are bound to one at a time.
 456  */
 457 typedef struct wcsession wcsession;
 458 struct wcsession {
 459 /* infrastructural members */
 460         wcsession *next;                        /**< Linked list */
 461         pthread_mutex_t SessionMutex;           /**< mutex for exclusive access */
 462         int wc_session;                         /**< WebCit session ID */
 463         int killthis;                           /**< Nonzero == purge this session */
 464         int is_mobile;                          /**< Client is a handheld browser */
 465         int ctdl_pid;                           /**< Session ID on the Citadel server */
 466         int nonce;                              /**< session nonce (to prevent session riding) */
 467         int SessionKey;
 468
 469 /* Session local Members */
 470         int serv_sock;                          /**< Client socket to Citadel server */
 471         StrBuf *ReadBuf;                        /**< here we keep our stuff while reading linebuffered from the server. */
 472         StrBuf *MigrateReadLineBuf;             /**< here we buffer legacy server read stuff */
 473         const char *ReadPos;                    /**< whats our read position in ReadBuf? */
 474         int chat_sock;                          /**< Client socket to Citadel server - for chat */
 475         time_t lastreq;                         /**< Timestamp of most recent HTTP */
 476         time_t last_pager_check;                /**< last time we polled for instant msgs */
 477         ServInfo *serv_info;                   /**< Iformation about the citserver we're connected to */
 478         int is_ajax;                            /** < are we doing an ajax request? */
 479
 480 /* Request local Members */
 481         StrBuf *CLineBuf;                       /**< linebuffering client stuff */
 482         ParsedHttpHdrs *Hdr;
 483         StrBuf *WBuf;                           /**< Our output buffer */
 484         StrBuf *HBuf;                           /**< Our HeaderBuffer */
 485
 486         HashList *vars;                         /**< HTTP variable substitutions for this page */
 487         StrBuf *trailing_javascript;            /**< extra javascript to be appended to page */
 488         char ImportantMessage[SIZ];             /**< ??? todo */
 489         StrBuf *ImportantMsg;
 490
 491 /* accounting */
 492         StrBuf *wc_username;                    /**< login name of current user */
 493         StrBuf *wc_fullname;                    /**< Screen name of current user */
 494         StrBuf *wc_password;                    /**< Password of current user */
 495         StrBuf *httpauth_pass;                  /**< only for GroupDAV sessions */
 496         int axlevel;                            /**< this user's access level */
 497         int is_aide;                            /**< nonzero == this user is an Aide */
 498         int is_room_aide;                       /**< nonzero == this user is a Room Aide in this room */
 499         int connected;                          /**< nonzero == we are connected to Citadel */
 500         int logged_in;                          /**< nonzero == we are logged in  */
 501         int need_regi;                          /**< This user needs to register. */
 502         int need_vali;                          /**< New users require validation. */
 503
 504 /* Preferences */
 505         StrBuf *cs_inet_email;                  /**< User's preferred Internet addr. */
 506         char reply_to[512];                     /**< reply-to address */
 507         HashList *hash_prefs;                   /**< WebCit preferences for this user */
 508         StrBuf *DefaultCharset;                 /**< Charset the user preferes */
 509         int downloaded_prefs;                   /** Has the client download its prefs yet? */
 510         int SavePrefsToServer;                  /**< Should we save our preferences to the server at the end of the request? */
 511         int selected_language;                  /**< Language selected by user */
 512         int time_format_cache;                  /**< which timeformat does our user like? */
 513
 514 /* current room related */
 515         StrBuf *wc_roomname;                    /**< Room we are currently in */
 516         unsigned room_flags;                    /**< flags associated with the current room */
 517         unsigned room_flags2;                   /**< flags associated with the current room */
 518         int wc_view;                            /**< view for the current room */
 519         int wc_default_view;                    /**< default view for the current room */
 520         int wc_is_trash;                        /**< nonzero == current room is a Trash folder */
 521         int wc_floor;                           /**< floor number of current room */
 522         int is_mailbox;                         /**< the current room is a private mailbox */
 523
 524 /* next/previous room thingabob */
 525         struct march *march;                    /**< march mode room list */
 526         char ugname[128];                       /**< where does 'ungoto' take us */
 527         long uglsn;                             /**< last seen message number for ungoto */
 528
 529 /* Uploading; mime attachments for composing messages */
 530         HashList *attachments;                  /**< list of attachments for 'enter message' */
 531         int upload_length;                      /**< content length of http-uploaded data */
 532         char *upload;                           /**< pointer to http-uploaded data */
 533         char upload_filename[PATH_MAX];         /**< filename of http-uploaded data */
 534         char upload_content_type[256];          /**< content type of http-uploaded data */
 535
 536         int new_mail;                           /**< user has new mail waiting */
 537         int remember_new_mail;                  /**< last count of new mail messages */
 538
 539 /* Roomiew control */
 540         HashList *summ;                         /**< list of messages for mailbox summary view */
 541   /** Perhaps these should be within a struct instead */
 542         long startmsg;                          /**< message number to start at */
 543         long maxmsgs;                           /**< maximum messages to display */
 544         long num_displayed;                     /**< number of messages actually displayed */
 545         HashList *disp_cal_items;               /**< sorted list of calendar items; startdate is the sort criteria. */
 546
 547
 548         char last_chat_user[256];               /**< ??? todo */
 549
 550 /* Iconbar controls */
 551         struct folder *cache_fold;              /**< cache the iconbar room list */
 552         int cache_max_folders;                  /**< ??? todo */
 553         int cache_num_floors;                   /**< ??? todo */
 554         time_t cache_timestamp;                 /**< ??? todo */
 555         HashList *IconBarSettings;             /**< which icons should be shown / not shown? */
 556         const StrBuf *floordiv_expanded;        /**< which floordiv currently expanded */
 557
 558
 559
 560 /* cache stuff for templates. TODO: find a smartrer way */
 561         HashList *ServCfg;                      /**< cache our server config for editing */
 562         HashList *InetCfg;                      /**< Our inet server config for editing */
 563
 564 };
 565
 566
 567 typedef void (*Header_Evaluator)(StrBuf *Line, ParsedHttpHdrs *hdr);
 568
 569 typedef struct _HttpHeader {
 570         Header_Evaluator H;
 571         StrBuf *Val;
 572         int HaveEvaluator;
 573 } OneHttpHeader;
 574
 575 void RegisterHeaderHandler(const char *Name, long Len, Header_Evaluator F);
 576
 577
 578 /* values for WC->current_iconbar */
 579 enum {
 580         current_iconbar_menu,     /* view the icon menue */
 581         current_iconbar_roomlist  /* view the roomtree */
 582 };
 583 enum {
 584         S_SELECT,
 585         S_SHUTDOWN,
 586         MAX_SEMAPHORES
 587 };
 588
 589
 590 /*
 591  * calview contains data passed back and forth between the message fetching loop
 592  * and the calendar view renderer.
 593  */
 594 enum {
 595         calview_month,
 596         calview_day,
 597         calview_week,
 598         calview_brief,
 599         calview_summary
 600 };
 601
 602 struct calview {
 603         int view;
 604         int year;
 605         int month;
 606         int day;
 607         time_t lower_bound;
 608         time_t upper_bound;
 609 };
 610
 611 #ifndef num_parms
 612 #define num_parms(source)               num_tokens(source, '|')
 613 #endif
 614
 615 /* Per-session data */
 616 #define WC ((struct wcsession *)pthread_getspecific(MyConKey))
 617 extern pthread_key_t MyConKey;
 618
 619 /* Per-thread SSL context */
 620 #ifdef HAVE_OPENSSL
 621 #define THREADSSL ((SSL *)pthread_getspecific(ThreadSSL))
 622 extern pthread_key_t ThreadSSL;
 623 extern char ctdl_key_dir[PATH_MAX];
 624 extern char file_crpt_file_key[PATH_MAX];
 625 extern char file_crpt_file_csr[PATH_MAX];
 626 extern char file_crpt_file_cer[PATH_MAX];
 627 #endif
 628
 629 extern char floorlist[128][SIZ];
 630 extern char *axdefs[];
 631 extern char *ctdlhost, *ctdlport;
 632 extern int http_port;
 633 extern char *server_cookie;
 634 extern int is_https;
 635 extern int setup_wizard;
 636 extern char wizard_filename[];
 637 extern int follow_xff;
 638
 639 void InitialiseSemaphores(void);
 640 void begin_critical_section(int which_one);
 641 void end_critical_section(int which_one);
 642
 643 void stuff_to_cookie(char *cookie, size_t clen,
 644                 int session,
 645                 StrBuf *user,
 646                 StrBuf *pass,
 647                 StrBuf *room,
 648                 char *language
 649 );
 650 void cookie_to_stuff(StrBuf *cookie,
 651                 int *session,
 652                 StrBuf *user,
 653                 StrBuf *pass,
 654                 StrBuf *room,
 655                 StrBuf *language
 656 );
 657 void locate_host(StrBuf *TBuf, int);
 658 void become_logged_in(const StrBuf *user, const StrBuf *pass, StrBuf *serv_response);
 659 void openid_manual_create(void);
 660 void display_login();
 661 void display_openids(void);
 662 void do_welcome(void);
 663 void do_logout(void);
 664 void display_main_menu(void);
 665 void display_aide_menu(void);
 666 void display_advanced_menu(void);
 667 void slrp_highest(void);
 668 ServInfo *get_serv_info(StrBuf *, StrBuf *);
 669 int GetConnected(void);
 670 void DeleteServInfo(ServInfo **FreeMe);
 671 int uds_connectsock(char *);
 672 int tcp_connectsock(char *, char *);
 673 int serv_getln(char *strbuf, int bufsize);
 674 int StrBuf_ServGetln(StrBuf *buf);
 675 int GetServerStatus(StrBuf *Line, long* FullState);
 676 void serv_puts(const char *string);
 677 void who(void);
 678 void who_inner_div(void);
 679 void ajax_mini_calendar(void);
 680 void fmout(char *align);
 681 void _fmout(StrBuf *Targt, char *align);
 682 void FmOut(StrBuf *Target, char *align, StrBuf *Source);
 683 void pullquote_fmout(void);
 684 void wDumpContent(int);
 685
 686 int Flathash(const char *str, long len);
 687
 688
 689
 690
 691
 692 void UrlescPutStrBuf(const StrBuf *strbuf);
 693 void StrEscPuts(const StrBuf *strbuf);
 694 void StrEscputs1(const StrBuf *strbuf, int nbsp, int nolinebreaks);
 695
 696 void urlescputs(const char *);
 697 void hurlescputs(const char *);
 698 void jsesc(char *, size_t, char *);
 699 void jsescputs(char *);
 700 void output_headers(    int do_httpheaders,
 701                         int do_htmlhead,
 702                         int do_room_banner,
 703                         int unset_cookies,
 704                         int suppress_check,
 705                         int cache);
 706 void output_custom_content_header(const char *ctype);
 707 void wprintf(const char *format,...)__attribute__((__format__(__printf__,1,2)));
 708 void hprintf(const char *format,...)__attribute__((__format__(__printf__,1,2)));
 709 void output_static(const char* What);
 710
 711 void print_menu_box(char* Title, char *Class, int nLines, ...);
 712 long stresc(char *target, long tSize, char *strbuf, int nbsp, int nolinebreaks);
 713 void escputs(const char *strbuf);
 714 void url(char *buf, size_t bufsize);
 715 void UrlizeText(StrBuf* Target, StrBuf *Source, StrBuf *WrkBuf);
 716 void escputs1(const char *strbuf, int nbsp, int nolinebreaks);
 717 void msgesc(char *target, size_t tlen, char *strbuf);
 718 void msgescputs(char *strbuf);
 719 void msgescputs1(char *strbuf);
 720 void dump_vars(void);
 721 void embed_main_menu(void);
 722
 723 void SetAccessCommand(long Oper);
 724 void do_addrbook_view(addrbookent *addrbook, int num_ab);
 725 void fetch_ab_name(message_summary *Msg, char **namebuf);
 726 void display_vcard(StrBuf *Target, StrBuf *vcard_source, char alpha, int full, char **storename, long msgnum);
 727 void jsonMessageList(void);
 728 void new_summary_view(void);
 729 void getseen(void);
 730 void text_to_server(char *ptr);
 731 void text_to_server_qp(char *ptr);
 732 void confirm_delete_msg(void);
 733 void display_success(char *);
 734 void authorization_required(const char *message);
 735 void CheckAuthBasic(ParsedHttpHdrs *hdr);
 736 void GetAuthBasic(ParsedHttpHdrs *hdr);
 737 void server_to_text(void);
 738 void save_edit(char *description, char *enter_cmd, int regoto);
 739 void display_edit(char *description, char *check_cmd,
 740                   char *read_cmd, char *save_cmd, int with_room_banner);
 741 long gotoroom(const StrBuf *gname);
 742 void confirm_delete_room(void);
 743 void validate(void);
 744 void display_graphics_upload(char *, char *, char *);
 745 void do_graphics_upload(char *upl_cmd);
 746 void serv_gets(char *strbuf);
 747 void serv_write(const char *buf, int nbytes);
 748 void serv_putbuf(const StrBuf *string);
 749 void serv_printf(const char *format,...)__attribute__((__format__(__printf__,1,2)));
 750 void load_floorlist(StrBuf *Buf);
 751 void shutdown_sessions(void);
 752 void do_housekeeping(void);
 753 void smart_goto(const StrBuf *);
 754 void worker_entry(void);
 755 void session_loop(void);
 756 size_t wc_strftime(char *s, size_t max, const char *format, const struct tm *tm);
 757 void fmt_time(char *buf, size_t siz, time_t thetime);
 758 void httpdate(char *buf, time_t thetime);
 759 time_t httpdate_to_timestamp(StrBuf *buf);
 760 void end_webcit_session(void);
 761 void page_popup(void);
 762 void http_redirect(const char *);
 763 void clear_substs(struct wcsession *wc);
 764 void clear_local_substs(void);
 765
 766
 767
 768 int lingering_close(int fd);
 769 char *memreadline(char *start, char *buf, int maxlen);
 770 char *memreadlinelen(char *start, char *buf, int maxlen, int *retlen);
 771 long extract_token(char *dest, const char *source, int parmnum, char separator, int maxlen);
 772 void remove_token(char *source, int parmnum, char separator);
 773 StrBuf *load_mimepart(long msgnum, char *partnum);
 774 void MimeLoadData(wc_mime_attachment *Mime);
 775 int pattern2(char *search, char *patn);
 776 void do_edit_vcard(long msgnum, char *partnum,
 777                    message_summary *VCMsg,
 778                    wc_mime_attachment *VCAtt,
 779                    char *return_to,
 780                    const char *force_room);
 781
 782 void select_user_to_edit(const char *preselect);
 783 void delete_user(char *);
 784 void do_change_view(int);
 785 void folders(void);
 786
 787
 788
 789 void display_addressbook(long msgnum, char alpha);
 790 void offer_start_page(StrBuf *Target, WCTemplputParams *TP);
 791 void convenience_page(const char *titlebarcolor, const char *titlebarmsg, const char *messagetext);
 792 void output_html(const char *, int, int, StrBuf *, StrBuf *);
 793 void do_listsub(void);
 794 ssize_t write(int fd, const void *buf, size_t count);
 795 void cal_process_attachment(wc_mime_attachment *Mime);
 796 void load_calendar_item(message_summary *Msg, int unread, struct calview *c);
 797 void display_calendar(message_summary *Msg, int unread);
 798 void display_task(message_summary *Msg, int unread);
 799 void display_note(message_summary *Msg, int unread);
 800 void updatenote(void);
 801 void parse_calendar_view_request(struct calview *c);
 802 void render_calendar_view(struct calview *c);
 803 void do_tasks_view(void);
 804 int calendar_summary_view(void);
 805 void free_march_list(wcsession *wcf);
 806 void display_rules_editor_inner_div(void);
 807 void generate_uuid(char *);
 808 void CtdlMakeTempFileName(char *, int);
 809 void address_book_popup(void);
 810 void begin_ajax_response(void);
 811 void end_ajax_response(void);
 812 void initialize_viewdefs(void);
 813 void initialize_axdefs(void);
 814 void burn_folder_cache(time_t age);
 815 void list_all_rooms_by_floor(const char *viewpref);
 816 void display_pictureview(void);
 817
 818 void display_edit_task(void);
 819 void display_edit_event(void);
 820 icaltimezone *get_default_icaltimezone(void);
 821 void display_icaltimetype_as_webform(struct icaltimetype *, char *, int);
 822 void icaltime_from_webform(struct icaltimetype *result, char *prefix);
 823 void icaltime_from_webform_dateonly(struct icaltimetype *result, char *prefix);
 824 void display_edit_individual_event(icalcomponent *supplied_vtodo, long msgnum, char *from,
 825         int unread, struct calview *calv);
 826 void save_individual_event(icalcomponent *supplied_vtodo, long msgnum, char *from,
 827         int unread, struct calview *calv);
 828 void ical_dezonify(icalcomponent *cal);
 829 void partstat_as_string(char *buf, icalproperty *attendee);
 830 icalcomponent *ical_encapsulate_subcomponent(icalcomponent *subcomp);
 831 void check_attendee_availability(icalcomponent *supplied_vevent);
 832 int ical_ctdl_is_overlap(
 833                         struct icaltimetype t1start,
 834                         struct icaltimetype t1end,
 835                         struct icaltimetype t2start,
 836                         struct icaltimetype t2end
 837 );
 838
 839
 840 extern char *months[];
 841 extern char *days[];
 842 int read_server_binary(StrBuf *Ret, size_t total_len, StrBuf *Buf);
 843 int StrBuf_ServGetBLOB(StrBuf *buf, long BlobSize);
 844 int StrBuf_ServGetBLOBBuffered(StrBuf *buf, long BlobSize);
 845 int read_server_text(StrBuf *Buf, long *nLines);
 846 int goto_config_room(StrBuf *Buf);
 847 long locate_user_vcard_in_this_room(message_summary **VCMsg,
 848                                     wc_mime_attachment **VCAtt);
 849 void sleeeeeeeeeep(int);
 850 void http_transmit_thing(const char *content_type, int is_static);
 851 long unescape_input(char *buf);
 852 void do_selected_iconbar(void);
 853 void spawn_another_worker_thread(void);
 854 void StrEndTab(StrBuf *Target, int tabnum, int num_tabs);
 855 void StrBeginTab(StrBuf *Target, int tabnum, int num_tabs);
 856 void StrTabbedDialog(StrBuf *Target, int num_tabs, StrBuf *tabnames[]);
 857 void tabbed_dialog(int num_tabs, char *tabnames[]);
 858 void begin_tab(int tabnum, int num_tabs);
 859 void end_tab(int tabnum, int num_tabs);
 860 void str_wiki_index(char *s);
 861 long guess_calhourformat(void);
 862 int get_time_format_cached (void);
 863 int xtoi(const char *in, size_t len);
 864 const char *get_selected_language(void);
 865
 866 #define DATEFMT_FULL 0
 867 #define DATEFMT_BRIEF 1
 868 #define DATEFMT_RAWDATE 2
 869 #define DATEFMT_LOCALEDATE 3
 870 void webcit_fmt_date(char *buf, size_t siz, time_t thetime, int Format);
 871 int fetch_http(char *url, char *target_buf, int maxbytes);
 872 void free_attachments(wcsession *sess);
 873 void summary(void);
 874
 875 int is_mobile_ua(char *user_agent);
 876
 877 void embed_room_banner(char *, int);
 878 #define FLOOR_PARAM_LEN 3
 879 extern const char FLOOR_PARAM_NAMES[(FLOOR_PARAM_LEN + 1)][15];
 880 extern const int FLOOR_PARAM_NAMELEN[(FLOOR_PARAM_LEN + 1)];
 881 #define FPKEY(a) FLOOR_PARAM_NAMES[a], FLOOR_PARAM_NAMELEN[a]
 882 #define ROOM_PARAM_LEN 8
 883 extern const char ROOM_PARAM_NAMES[(ROOM_PARAM_LEN + 1)][20];
 884 extern const int ROOM_PARAM_NAMELEN[(ROOM_PARAM_LEN +1)];
 885 #define RPKEY(a) ROOM_PARAM_NAMES[a], ROOM_PARAM_NAMELEN[a]
 886 HashList *GetFloorListHash(StrBuf *Target, WCTemplputParams *TP);
 887 HashList *GetRoomListHash(StrBuf *Target, WCTemplputParams *TP);
 888 int SortRoomsByListOrder(const void *room1, const void *room2);
 889 /* navbar types that can be passed to embed_room_banner */
 890 enum {
 891         navbar_none,
 892         navbar_default
 893 };
 894
 895
 896 #ifdef HAVE_OPENSSL
 897 void init_ssl(void);
 898 void endtls(void);
 899 void ssl_lock(int mode, int n, const char *file, int line);
 900 int starttls(int sock);
 901 extern SSL_CTX *ssl_ctx;
 902 int client_read_sslbuffer(StrBuf *buf, int timeout);
 903 void client_write_ssl(const StrBuf *Buf);
 904 #endif
 905
 906 void utf8ify_rfc822_string(char *buf);
 907
 908 void begin_burst(void);
 909 long end_burst(void);
 910
 911 extern char *hourname[];        /* Names of hours (12am, 1am, etc.) */
 912
 913 void http_datestring(char *buf, size_t n, time_t xtime);
 914
 915 typedef void (*IcalCallbackFunc)(icalcomponent *, long, char*, int, struct calview *);
 916
 917 /* These should be empty, but we have them for testing */
 918 #define DEFAULT_HTTPAUTH_USER   ""
 919 #define DEFAULT_HTTPAUTH_PASS   ""
 920
 921
 922 /* Exit codes 101 through 109 are initialization failures so we don't want to
 923  * just keep respawning indefinitely.
 924  */
 925 #define WC_EXIT_BIND            101     /* Can't bind to the port */
 926 #define WC_EXIT_SSL             102     /* Can't initialize SSL */
 927
 928
 929 #define WC_TIMEFORMAT_NONE 0
 930 #define WC_TIMEFORMAT_AMPM 1
 931 #define WC_TIMEFORMAT_24 2
 932
 933
 934 void LoadIconSettings(void);