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