webcit/webcit.h

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