webcit/webcit.h

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