webcit/webcit.h

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