webcit/webcit.h

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