webcit/webcit.h

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