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