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