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