webcit/webcit.h

   1 /* $Id$ */
   2
   3 #include "sysdep.h"
   4
   5
   6 #include <sys/select.h>
   7
   8 #include <ctype.h>
   9 #include <stdlib.h>
  10 #ifdef HAVE_UNISTD_H
  11 #include <unistd.h>
  12 #endif
  13 #include <stdio.h>
  14 #ifdef HAVE_FCNTL_H
  15 #include <fcntl.h>
  16 #endif
  17 #include <signal.h>
  18 #include <sys/types.h>
  19 #include <sys/wait.h>
  20 #include <sys/socket.h>
  21 #ifdef HAVE_SYS_TIME_H
  22 #include <sys/time.h>
  23 #endif
  24 #include <sys/stat.h>
  25 #ifdef HAVE_LIMITS_H
  26 #include <limits.h>
  27 #endif
  28 #include <netinet/in.h>
  29 #include <arpa/inet.h>
  30 #include <sys/un.h>
  31 #include <netdb.h>
  32 #include <sys/poll.h>
  33 #include <string.h>
  34 #include <pwd.h>
  35 #include <errno.h>
  36 #include <stdarg.h>
  37 #include <pthread.h>
  38 #include <signal.h>
  39 #include <sys/utsname.h>
  40
  41 #include <libcitadel.h>
  42
  43 #ifndef INADDR_NONE
  44 #define INADDR_NONE 0xffffffff
  45 #endif
  46
  47 #ifdef HAVE_ICONV
  48 #include <iconv.h>
  49 #endif
  50
  51 #ifdef ENABLE_NLS
  52 #include <libintl.h>
  53 #include <locale.h>
  54 #ifdef HAVE_USELOCALE
  55 extern locale_t wc_locales[];
  56 #endif
  57 #define _(string)       gettext(string)
  58 #else
  59 #define _(string)       (string)
  60 #endif
  61
  62 #define IsEmptyStr(a) ((a)[0] == '\0')
  63 /*
  64  * Uncomment to dump an HTTP trace to stderr
  65 #define HTTP_TRACING 1
  66  */
  67
  68 #ifdef HTTP_TRACING
  69 #undef HAVE_ZLIB_H
  70 #undef HAVE_ZLIB
  71 #endif
  72
  73 #ifdef HAVE_ZLIB_H
  74 #include <zlib.h>
  75 #endif
  76
  77
  78 /* Work around PACKAGE/VERSION defs that are (not supposed to be?) in ical.h */
  79 #ifdef PACKAGE
  80 # define CTDL_PACKAGE PACKAGE
  81 # undef PACKAGE
  82 #endif
  83
  84 #ifdef PACKAGE_STRING
  85 # define CTDL_PACKAGE_STRING PACKAGE_STRING
  86 //# undef PACKAGE_STRING
  87 #endif
  88
  89 #ifdef VERSION
  90 # define CTDL_VERSION VERSION
  91 # undef VERSION
  92 #endif
  93
  94 #include <ical.h>
  95
  96 #undef PACKAGE
  97 #undef VERSION
  98 #undef PACKAGE_NAME
  99 #undef PACKAGE_STRING
 100 #undef PACKAGE_TARNAME
 101 #undef PACKAGE_VERSION
 102 #undef PACKAGE_BUGREPORT
 103 #include "sysdep.h"
 104
 105 ////////#include "hash.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 #endif
 114
 115 #define CALENDAR_ROOM_NAME      "Calendar"
 116 #define PRODID "-//Citadel//NONSGML Citadel Calendar//EN"
 117
 118 #define SIZ                     4096            /* generic buffer size */
 119
 120 #define TRACE fprintf(stderr, "Checkpoint: %s, %d\n", __FILE__, __LINE__)
 121
 122 #define SLEEPING                180             /* TCP connection timeout */
 123 #define WEBCIT_TIMEOUT          900             /* WebCit session timeout */
 124 #define PORT_NUM                2000            /* port number to listen on */
 125 #define DEVELOPER_ID            0
 126 #define CLIENT_ID               4
 127 #define CLIENT_VERSION          737             /* This version of WebCit */
 128 #define MINIMUM_CIT_VERSION     737             /* min required Citadel ver */
 129 #define LIBCITADEL_MIN          738             /* min required libcitadel ver */
 130 #define DEFAULT_HOST            "localhost"     /* Default Citadel server */
 131 #define DEFAULT_PORT            "504"
 132 #define LB                      (1)             /* Internal escape chars */
 133 #define RB                      (2)
 134 #define QU                      (3)
 135 #define TARGET                  "webcit01"      /* Target for inline URL's */
 136 #define HOUSEKEEPING            15              /* Housekeeping frequency */
 137 #define MIN_WORKER_THREADS      5
 138 #define MAX_WORKER_THREADS      250
 139 #define LISTEN_QUEUE_LENGTH     100             /* listen() backlog queue */
 140
 141 #define USERCONFIGROOM          "My Citadel Config"
 142 #define DEFAULT_MAXMSGS         20
 143
 144
 145 #ifdef LIBCITADEL_VERSION_NUMBER
 146 #if LIBCITADEL_VERSION_NUMBER < LIBCITADEL_MIN
 147 #error libcitadel is too old.  Please upgrade it before continuing.
 148 #endif
 149 #endif
 150
 151
 152 /*
 153  * Room flags (from Citadel)
 154  *
 155  * bucket one...
 156  */
 157 #define QR_PERMANENT    1               /**< Room does not purge                */
 158 #define QR_INUSE        2               /**< Set if in use, clear if avail      */
 159 #define QR_PRIVATE      4               /**< Set for any type of private room   */
 160 #define QR_PASSWORDED   8               /**< Set if there's a password too      */
 161 #define QR_GUESSNAME    16              /**< Set if it's a guessname room       */
 162 #define QR_DIRECTORY    32              /**< Directory room                     */
 163 #define QR_UPLOAD       64              /**< Allowed to upload                  */
 164 #define QR_DOWNLOAD     128             /**< Allowed to download                */
 165 #define QR_VISDIR       256             /**< Visible directory                  */
 166 #define QR_ANONONLY     512             /**< Anonymous-Only room                */
 167 #define QR_ANONOPT      1024            /**< Anonymous-Option room              */
 168 #define QR_NETWORK      2048            /**< Shared network room                */
 169 #define QR_PREFONLY     4096            /**< Preferred status needed to enter   */
 170 #define QR_READONLY     8192            /**< Aide status required to post       */
 171 #define QR_MAILBOX      16384           /**< Set if this is a private mailbox   */
 172
 173 /**
 174  * bucket two...
 175  */
 176 #define QR2_SYSTEM      1               /**< System room; hide by default       */
 177 #define QR2_SELFLIST    2               /**< Self-service mailing list mgmt     */
 178 #define QR2_COLLABDEL   4               /**< Anyone who can post can also delete*/
 179 #define QR2_SUBJECTREQ  8               /**< Subject strongly recommended */
 180 #define QR2_SMTP_PUBLIC 16              /* smtp public postable room */
 181 #define QR2_MODERATED   32              /* Listservice aide has to permit posts  */
 182
 183 /**
 184  * user/room access
 185  */
 186 #define UA_KNOWN        2
 187 #define UA_GOTOALLOWED  4
 188 #define UA_HASNEWMSGS   8
 189 #define UA_ZAPPED       16
 190
 191
 192 /**
 193  * User flags (from Citadel)
 194  */
 195 #define US_NEEDVALID    1               /**< User needs to be validated         */
 196 #define US_PERM         4               /**< Permanent user                     */
 197 #define US_LASTOLD      16              /**< Print last old message with new    */
 198 #define US_EXPERT       32              /**< Experienced user                   */
 199 #define US_UNLISTED     64              /**< Unlisted userlog entry             */
 200 #define US_NOPROMPT     128             /**< Don't prompt after each message    */
 201 #define US_PROMPTCTL    256             /**< <N>ext & <S>top work at prompt     */
 202 #define US_DISAPPEAR    512             /**< Use "disappearing msg prompts"     */
 203 #define US_REGIS        1024            /**< Registered user                    */
 204 #define US_PAGINATOR    2048            /**< Pause after each screen of text    */
 205 #define US_INTERNET     4096            /**< Internet mail privileges           */
 206 #define US_FLOORS       8192            /**< User wants to see floors           */
 207 #define US_COLOR        16384           /**< User wants ANSI color support      */
 208 #define US_USER_SET     (US_LASTOLD | US_EXPERT | US_UNLISTED | \
 209                         US_NOPROMPT | US_DISAPPEAR | US_PAGINATOR | \
 210                         US_FLOORS | US_COLOR | US_PROMPTCTL )
 211
 212 /*
 213  * NLI is the string that shows up in a who's online listing for sessions
 214  * that are active, but for which no user has yet authenticated.
 215  */
 216 #define NLI     "(not logged in)"
 217
 218
 219 /** \brief      Linked list of lines appearing in an HTTP client request */
 220 struct httprequest {
 221         struct httprequest *next;  /**< the next request in the list */
 222         char line[SIZ];            /**< the request line */
 223 };
 224
 225 /**
 226  * \brief       Linked list of session variables encoded in an x-www-urlencoded content type
 227  */
 228 typedef struct urlcontent urlcontent;
 229 struct urlcontent {
 230         char url_key[32];          /**< the variable name */
 231         StrBuf *url_data;            /**< its value */
 232 };
 233
 234 /**
 235  * \brief information about us ???
 236  */
 237 struct serv_info {
 238         int serv_pid;                   /* Process ID of the Citadel server */
 239         char serv_nodename[32];         /* Node name of the Citadel server */
 240         char serv_humannode[64];        /* human readable node name of the Citadel server */
 241         char serv_fqdn[64];             /* fully quallified Domain Name (such as uncensored.citadel.org) */
 242         char serv_software[64];         /* What version does our connected citadel server use */
 243         int serv_rev_level;             /* Whats the citadel server revision */
 244         char serv_bbs_city[64];         /* Geographic location of the Citadel server */
 245         char serv_sysadm[64];           /* Name of system administrator */
 246         char serv_moreprompt[256];      /* Whats the commandline textprompt */
 247         int serv_ok_floors;             /* nonzero == server supports floors */
 248         int serv_supports_ldap;         /* is the server linked against an ldap tree for adresses? */
 249         int serv_newuser_disabled;      /* Has the server disabled self-service new user creation? */
 250         char serv_default_cal_zone[128];/* Default timezone for unspecified calendar items */
 251         int serv_supports_sieve;        /* Does the server support Sieve mail filtering? */
 252         int serv_fulltext_enabled;      /* Does the server have the full text index enabled? */
 253         char serv_svn_revision[256];    /* SVN revision of the server */
 254         int serv_supports_openid;       /* Does the server support authentication via OpenID? */
 255 };
 256
 257
 258
 259 /**
 260  * \brief This struct holds a list of rooms for \\\<G\\\>oto operations.
 261  */
 262 struct march {
 263         struct march *next;       /**< pointer to next in linked list */
 264         char march_name[128];     /**< name of room */
 265         int march_floor;          /**< floor number of room */
 266         int march_order;          /**< sequence in which we are to visit this room */
 267 };
 268
 269 /* *
 270  * \brief       This struct holds a list of rooms for client display.
 271  *              It is a binary tree.
 272  */
 273 struct roomlisting {
 274         struct roomlisting *lnext;      /**< pointer to 'left' tree node */
 275         struct roomlisting *rnext;      /**< pointer to 'right' tree node */
 276         char rlname[128];               /**< name of room */
 277         unsigned rlflags;               /**< room flags */
 278         int rlfloor;                    /**< the floor it resides on */
 279         int rlorder;                    /**< room listing order */
 280 };
 281
 282
 283
 284 /**
 285  * \brief Dynamic content for variable substitution in templates
 286  */
 287 typedef struct _wcsubst {
 288         int wcs_type;                       /**< which type of ??? */
 289         char wcs_key[32];                   /**< ??? what?*/
 290         void *wcs_value;                    /**< ???? what?*/
 291         void (*wcs_function)(void); /**< funcion hook ???*/
 292 } wcsubst;
 293
 294 #define TYPE_STR   1
 295 #define TYPE_LONG  2
 296 #define MAXPARAM  10
 297 typedef struct _TemplateParam {
 298         const char *Start;
 299         int Type;
 300         long len;
 301         long lvalue;
 302 } TemplateParam;
 303
 304 typedef struct _TemplateToken {
 305         const char *pTokenStart;
 306         size_t TokenStart;
 307         size_t TokenEnd;
 308         const char *pTokenEnd;
 309         int IsGettext;
 310
 311         const char *pName;
 312         size_t NameEnd;
 313
 314         int HaveParameters;
 315         int nParameters;
 316         TemplateParam *Params[MAXPARAM];
 317 } WCTemplateToken;
 318
 319 typedef void (*WCHandlerFunc)(StrBuf *Target, int nArgs, WCTemplateToken *Token, void *Context);
 320 void RegisterNS(const char *NSName, long len,
 321                 int nMinArgs,
 322                 int nMaxArgs,
 323                 WCHandlerFunc HandlerFunc);
 324 #define RegisterNamespace(a, b, c, d) RegisterNS(a, sizeof(a)-1, b, c, d)
 325
 326
 327 typedef void (*SubTemplFunc)(StrBuf *TemplBuffer, void *Context);
 328 typedef HashList *(*RetrieveHashlistFunc)(void);
 329 typedef void (*HashDestructorFunc) (HashList *KillMe);
 330 void RegisterITERATOR(const char *Name, long len,
 331                       HashList *StaticList,
 332                       RetrieveHashlistFunc GetHash,
 333                       SubTemplFunc DoSubTempl,
 334                       HashDestructorFunc Destructor);
 335 #define RegisterIterator(a, b, c, d, e) RegisterITERATOR(a, sizeof(a)-1, b, c, d, e)
 336
 337
 338 /**
 339  * \brief Values for wcs_type
 340  */
 341 enum {
 342         WCS_STRING,       /**< its a string */
 343         WCS_FUNCTION,     /**< its a function callback */
 344         WCS_SERVCMD,      /**< its a command to send to the citadel server */
 345         WCS_STRBUF,       /**< its a strbuf we own */
 346         WCS_STRBUF_REF    /**< its a strbuf we mustn't free */
 347 };
 348
 349 /**
 350  * \brief mail attachment ???
 351  */
 352 struct wc_attachment {
 353         struct wc_attachment *next;/**< pointer to next in list */
 354         size_t length;                     /**< length of the contenttype */
 355         char content_type[SIZ];    /**< the content itself ???*/
 356         char filename[SIZ];                /**< the filename hooked to this content ??? */
 357         char *data;                /**< the data pool; aka this content */
 358 };
 359
 360 /**
 361  * \brief message summary structure. ???
 362  */
 363 struct message_summary {
 364         time_t date;        /**< its creation date */
 365         long msgnum;            /**< the message number on the citadel server */
 366         char from[128];         /**< the author */
 367         char to[128];           /**< the recipient */
 368         char subj[256];         /**< the title / subject */
 369         int hasattachments;     /**< does it have atachments? */
 370         int is_new;         /**< is it yet read? */
 371 };
 372
 373 /**
 374  * \brief  Data structure for roomlist-to-folderlist conversion
 375  */
 376 struct folder {
 377         int floor;      /**< which floor is it on */
 378         char room[SIZ]; /**< which roomname ??? */
 379         char name[SIZ]; /**< which is its own name??? */
 380         int hasnewmsgs; /**< are there unread messages inside */
 381         int is_mailbox; /**< is it a mailbox?  */
 382         int selectable; /**< can we select it ??? */
 383         int view;       /**< whats its default view? inbox/calendar.... */
 384         int num_rooms;  /**< If this is a floor, how many rooms does it have */
 385 };
 386
 387 typedef struct _disp_cal {
 388         icalcomponent *cal;             /**< cal items for display */
 389         long cal_msgnum;                /**< cal msgids for display */
 390         char *from;                     /**< owner of this component */
 391         int unread;                     /**< already seen by the user? */
 392
 393         time_t event_start;
 394         time_t event_end;
 395
 396         int multi_day_event;
 397         int is_repeat;
 398 } disp_cal;
 399
 400
 401 /**
 402  * \brief One of these is kept for each active Citadel session.
 403  * HTTP transactions are bound to on e at a time.
 404  */
 405 struct wcsession {
 406         struct wcsession *next;                 /**< Linked list */
 407         int wc_session;                         /**< WebCit session ID */
 408         char wc_username[128];                  /**< login name of current user */
 409         char wc_fullname[128];                  /**< Screen name of current user */
 410         char wc_password[128];                  /**< Password of current user */
 411         char wc_roomname[256];                  /**< Room we are currently in */
 412         int connected;                          /**< nonzero == we are connected to Citadel */
 413         int logged_in;                          /**< nonzero == we are logged in  */
 414         int axlevel;                            /**< this user's access level */
 415         int is_aide;                            /**< nonzero == this user is an Aide */
 416         int is_room_aide;                       /**< nonzero == this user is a Room Aide in this room */
 417         int http_sock;                          /**< HTTP server socket */
 418         int serv_sock;                          /**< Client socket to Citadel server */
 419         int chat_sock;                          /**< Client socket to Citadel server - for chat */
 420         unsigned room_flags;                    /**< flags associated with the current room */
 421         unsigned room_flags2;                   /**< flags associated with the current room */
 422         int wc_view;                            /**< view for the current room */
 423         int wc_default_view;                    /**< default view for the current room */
 424         int wc_is_trash;                        /**< nonzero == current room is a Trash folder */
 425         int wc_floor;                           /**< floor number of current room */
 426         char ugname[128];                       /**< where does 'ungoto' take us */
 427         long uglsn;                             /**< last seen message number for ungoto */
 428         int upload_length;                      /**< content length of http-uploaded data */
 429         char *upload;                           /**< pointer to http-uploaded data */
 430         char upload_filename[PATH_MAX];         /**< filename of http-uploaded data */
 431         char upload_content_type[256];          /**< content type of http-uploaded data */
 432         int new_mail;                           /**< user has new mail waiting */
 433         int remember_new_mail;                  /**< last count of new mail messages */
 434         int need_regi;                          /**< This user needs to register. */
 435         int need_vali;                          /**< New users require validation. */
 436         char cs_inet_email[256];                /**< User's preferred Internet addr. */
 437         pthread_mutex_t SessionMutex;           /**< mutex for exclusive access */
 438         time_t lastreq;                         /**< Timestamp of most recent HTTP */
 439         int killthis;                           /**< Nonzero == purge this session */
 440         struct march *march;                    /**< march mode room list */
 441         char reply_to[512];                     /**< reply-to address */
 442         long msgarr[10000];                     /**< for read operations */
 443         int num_summ;                           /**< number of messages in mailbox summary view */
 444         struct message_summary *summ;           /**< array of messages for mailbox summary view */
 445         int is_mobile;                  /**< Client is a handheld browser */
 446         HashList *urlstrings;                   /**< variables passed to webcit in a URL */
 447         HashList *vars;                         /**< HTTP variable substitutions for this page */
 448         char this_page[512];                    /**< URL of current page */
 449         char http_host[512];                    /**< HTTP Host: header */
 450         HashList *hash_prefs;                   /**< WebCit preferences for this user */
 451         HashList *disp_cal_items;               /**< sorted list of calendar items; startdate is the sort criteria. */
 452         struct wc_attachment *first_attachment; /**< linked list of attachments for 'enter message' */
 453         char last_chat_user[256];               /**< ??? todo */
 454         char ImportantMessage[SIZ];             /**< ??? todo */
 455         int ctdl_pid;                           /**< Session ID on the Citadel server */
 456         char httpauth_user[256];                /**< only for GroupDAV sessions */
 457         char httpauth_pass[256];                /**< only for GroupDAV sessions */
 458         int gzip_ok;                            /**< Nonzero if Accept-encoding: gzip */
 459         int is_mailbox;                         /**< the current room is a private mailbox */
 460         struct folder *cache_fold;              /**< cache the iconbar room list */
 461         int cache_max_folders;                  /**< ??? todo */
 462         int cache_num_floors;                   /**< ??? todo */
 463         time_t cache_timestamp;                 /**< ??? todo */
 464         HashList *IconBarSetttings;             /**< which icons should be shown / not shown? */
 465         long current_iconbar;                   /**< What is currently in the iconbar? */
 466         StrBuf *floordiv_expanded;              /**< which floordiv currently expanded */
 467         int selected_language;                  /**< Language selected by user */
 468         time_t last_pager_check;                /**< last time we polled for instant msgs */
 469         int nonce;                              /**< session nonce (to prevent session riding) */
 470         int time_format_cache;                  /**< which timeformat does our user like? */
 471         StrBuf *UrlFragment1;                   /**< first urlfragment, if NEED_URL is specified by the handler*/
 472         StrBuf *UrlFragment2;                   /**< second urlfragment, if NEED_URL is specified by the handler*/
 473         StrBuf *WBuf;                           /**< Our output buffer */
 474         StrBuf *HBuf;                           /**< Our HeaderBuffer */
 475 };
 476
 477 /** values for WC->current_iconbar */
 478 enum {
 479         current_iconbar_menu,     /**< view the icon menue */
 480         current_iconbar_roomlist  /**< view the roomtree */
 481 };
 482 enum {
 483         S_SELECT,
 484         S_SHUTDOWN,
 485         MAX_SEMAPHORES
 486 };
 487
 488 #ifndef num_parms
 489 #define num_parms(source)               num_tokens(source, '|')
 490 #endif
 491
 492 /* Per-session data */
 493 #define WC ((struct wcsession *)pthread_getspecific(MyConKey))
 494 extern pthread_key_t MyConKey;
 495
 496 /* Per-thread SSL context */
 497 #ifdef HAVE_OPENSSL
 498 #define THREADSSL ((SSL *)pthread_getspecific(ThreadSSL))
 499 extern pthread_key_t ThreadSSL;
 500 extern char ctdl_key_dir[PATH_MAX];
 501 extern char file_crpt_file_key[PATH_MAX];
 502 extern char file_crpt_file_csr[PATH_MAX];
 503 extern char file_crpt_file_cer[PATH_MAX];
 504 #endif
 505
 506 struct serv_info serv_info;
 507 extern char floorlist[128][SIZ];
 508 extern char *axdefs[];
 509 extern char *ctdlhost, *ctdlport;
 510 extern int http_port;
 511 extern char *server_cookie;
 512 extern int is_https;
 513 extern int setup_wizard;
 514 extern char wizard_filename[];
 515 extern time_t if_modified_since;
 516 extern int follow_xff;
 517 extern HashList *HandlerHash;
 518 extern HashList *PreferenceHooks;
 519 extern HashList *WirelessTemplateCache;
 520 extern HashList *WirelessLocalTemplateCache;
 521 extern HashList *TemplateCache;
 522 extern HashList *LocalTemplateCache;
 523 extern HashList *GlobalNS;
 524 extern HashList *Iterators;
 525 extern HashList *ZoneHash;
 526
 527
 528
 529 void InitialiseSemaphores(void);
 530 void begin_critical_section(int which_one);
 531 void end_critical_section(int which_one);
 532
 533
 534 void stuff_to_cookie(char *cookie, size_t clen, int session,
 535                         char *user, char *pass, char *room);
 536 void cookie_to_stuff(char *cookie, int *session,
 537                 char *user, size_t user_len,
 538                 char *pass, size_t pass_len,
 539                 char *room, size_t room_len);
 540 void locate_host(char *, int);
 541 void become_logged_in(char *, char *, char *);
 542 void openid_manual_create(void);
 543 void display_login(char *mesg);
 544 void display_openids(void);
 545 void do_welcome(void);
 546 void do_logout(void);
 547 void display_main_menu(void);
 548 void display_aide_menu(void);
 549 void display_advanced_menu(void);
 550 void slrp_highest(void);
 551 void get_serv_info(char *, char *);
 552 int uds_connectsock(char *);
 553 int tcp_connectsock(char *, char *);
 554 int serv_getln(char *strbuf, int bufsize);
 555 int StrBuf_ServGetln(StrBuf *buf);
 556 void serv_puts(const char *string);
 557 void who(void);
 558 void who_inner_div(void);
 559 void ajax_mini_calendar(void);
 560 void fmout(char *align);
 561 void _fmout(StrBuf *Targt, char *align);
 562 void pullquote_fmout(void);
 563 void wDumpContent(int);
 564
 565
 566 /* These may return NULL if not foud */
 567 #define sbstr(a) SBstr(a, sizeof(a) - 1)
 568 const StrBuf *SBSTR(const char *key);
 569 const StrBuf *SBstr(const char *key, size_t keylen);
 570
 571 #define xbstr(a, b) (char*) XBstr(a, sizeof(a) - 1, b)
 572 const char *XBstr(char *key, size_t keylen, size_t *len);
 573 const char *XBSTR(char *key, size_t *len);
 574
 575 #define lbstr(a) LBstr(a, sizeof(a) - 1)
 576 long LBstr(char *key, size_t keylen);
 577 long LBSTR(char *key);
 578
 579 #define ibstr(a) IBstr(a, sizeof(a) - 1)
 580 int IBstr(char *key, size_t keylen);
 581 int IBSTR(char *key);
 582
 583 #define havebstr(a) HaveBstr(a, sizeof(a) - 1)
 584 int HaveBstr(char *key, size_t keylen);
 585 int HAVEBSTR(char *key);
 586
 587 #define yesbstr(a) YesBstr(a, sizeof(a) - 1)
 588 int YesBstr(char *key, size_t keylen);
 589 int YESBSTR(char *key);
 590
 591 /* TODO: get rid of the non-const-typecast */
 592 #define bstr(a) (char*) Bstr(a, sizeof(a) - 1)
 593 const char *BSTR(char *key);
 594 const char *Bstr(char *key, size_t keylen);
 595
 596 void urlescputs(char *);
 597 void hurlescputs(char *);
 598 void jsesc(char *, size_t, char *);
 599 void jsescputs(char *);
 600 void output_headers(    int do_httpheaders,
 601                         int do_htmlhead,
 602                         int do_room_banner,
 603                         int unset_cookies,
 604                         int suppress_check,
 605                         int cache);
 606 void wprintf(const char *format,...)__attribute__((__format__(__printf__,1,2)));
 607 void hprintf(const char *format,...)__attribute__((__format__(__printf__,1,2)));
 608 void output_static(char *what);
 609 void display_mime_icon(void);
 610 void print_menu_box(char* Title, char *Class, int nLines, ...);
 611 long stresc(char *target, long tSize, char *strbuf, int nbsp, int nolinebreaks);
 612 void escputs(char *strbuf);
 613 void url(char *buf, size_t bufsize);
 614 void escputs1(char *strbuf, int nbsp, int nolinebreaks);
 615 void msgesc(char *target, size_t tlen, char *strbuf);
 616 void msgescputs(char *strbuf);
 617 void msgescputs1(char *strbuf);
 618 void stripout(char *str, char leftboundary, char rightboundary);
 619 void dump_vars(void);
 620 void embed_main_menu(void);
 621 void serv_read(char *buf, int bytes);
 622 void readloop(char *oper);
 623 void read_message(long msgnum, int printable_view, char *section);
 624 void text_to_server(char *ptr);
 625 void text_to_server_qp(char *ptr);
 626 void confirm_delete_msg(void);
 627 void display_success(char *);
 628 void authorization_required(const char *message);
 629 void server_to_text(void);
 630 void save_edit(char *description, char *enter_cmd, int regoto);
 631 void display_edit(char *description, char *check_cmd,
 632                   char *read_cmd, char *save_cmd, int with_room_banner);
 633 int gotoroom(char *gname);
 634 void confirm_delete_room(void);
 635 void validate(void);
 636 void display_graphics_upload(char *, char *, char *);
 637 void do_graphics_upload(char *upl_cmd);
 638 void serv_read(char *buf, int bytes);
 639 void serv_gets(char *strbuf);
 640 void serv_write(const char *buf, int nbytes);
 641 void serv_puts(const char *string);
 642 void serv_printf(const char *format,...)__attribute__((__format__(__printf__,1,2)));
 643 void load_floorlist(void);
 644 void shutdown_sessions(void);
 645 void do_housekeeping(void);
 646 void smart_goto(char *);
 647 void worker_entry(void);
 648 void session_loop(struct httprequest *);
 649 size_t wc_strftime(char *s, size_t max, const char *format, const struct tm *tm);
 650 void fmt_time(char *buf, time_t thetime);
 651 void httpdate(char *buf, time_t thetime);
 652 time_t httpdate_to_timestamp(char *buf);
 653 void end_webcit_session(void);
 654 void page_popup(void);
 655 void http_redirect(const char *);
 656 void clear_substs(struct wcsession *wc);
 657 void clear_local_substs(void);
 658
 659
 660 typedef void (*var_callback_fptr)();
 661
 662
 663 void SVPut(char *keyname, size_t keylen, int keytype, char *Data);
 664 #define svput(a, b, c) SVPut(a, sizeof(a) - 1, b, c)
 665 void svprintf(char *keyname, size_t keylen, int keytype, const char *format,...) __attribute__((__format__(__printf__,4,5)));
 666 void SVPRINTF(char *keyname, int keytype, const char *format,...) __attribute__((__format__(__printf__,3,4)));
 667 void SVCALLBACK(char *keyname, var_callback_fptr fcn_ptr);
 668 void SVCallback(char *keyname, size_t keylen,  var_callback_fptr fcn_ptr);
 669 #define svcallback(a, b) SVCallback(a, sizeof(a) - 1, b)
 670
 671 void SVPUTBuf(const char *keyname, int keylen, StrBuf *Buf, int ref);
 672 #define SVPutBuf(a, b, c); SVPUTBuf(a, sizeof(a) - 1, b, c)
 673
 674 void DoTemplate(const char *templatename, long len, void *Context, StrBuf *Target);
 675 #define do_template(a, b) DoTemplate(a, sizeof(a) -1, b, NULL);
 676
 677
 678 int lingering_close(int fd);
 679 char *memreadline(char *start, char *buf, int maxlen);
 680 char *memreadlinelen(char *start, char *buf, int maxlen, int *retlen);
 681 long extract_token(char *dest, const char *source, int parmnum, char separator, int maxlen);
 682 void remove_token(char *source, int parmnum, char separator);
 683 char *load_mimepart(long msgnum, char *partnum);
 684 int pattern2(char *search, char *patn);
 685 void do_edit_vcard(long, char *, char *, char *);
 686 void striplt(char *);
 687 void stripltlen(char *, int *);
 688 void select_user_to_edit(char *message, char *preselect);
 689 void delete_user(char *);
 690 void do_change_view(int);
 691 void folders(void);
 692
 693
 694 void load_preferences(void);
 695 void save_preferences(void);
 696 #define get_preference(a, b) get_PREFERENCE(a, sizeof(a) - 1, b)
 697 #define get_pref(a, b)       get_PREFERENCE(ChrPtr(a), StrLength(a), b)
 698 int get_PREFERENCE(const char *key, size_t keylen, StrBuf **value);
 699 #define set_preference(a, b, c) set_PREFERENCE(a, sizeof(a) - 1, b, c)
 700 #define set_pref(a, b, c)       set_PREFERENCE(ChrPtr(a), StrLength(a), b, c)
 701 void set_PREFERENCE(const char *key, size_t keylen, StrBuf *value, int save_to_server);
 702
 703 #define get_pref_long(a, b, c) get_PREF_LONG(a, sizeof(a) - 1, b, c)
 704 int get_PREF_LONG(const char *key, size_t keylen, long *value, long Default);
 705 #define set_pref_long(a, b, c) set_PREF_LONG(a, sizeof(a) - 1, b, c)
 706 void set_PREF_LONG(const char *key, size_t keylen, long value, int save_to_server);
 707
 708 #define get_pref_yesno(a, b, c) get_PREF_YESNO(a, sizeof(a) - 1, b, c)
 709 int get_PREF_YESNO(const char *key, size_t keylen, int *value, int Default);
 710 #define set_pref_yesno(a, b, c) set_PREF_YESNO(a, sizeof(a) - 1, b, c)
 711 void set_PREF_YESNO(const char *key, size_t keylen, int value, int save_to_server);
 712
 713 #define get_room_pref(a) get_ROOM_PREFS(a, sizeof(a) - 1)
 714 StrBuf *get_ROOM_PREFS(const char *key, size_t keylen);
 715
 716 #define set_room_pref(a, b, c) set_ROOM_PREFS(a, sizeof(a) - 1, b, c)
 717 void set_ROOM_PREFS(const char *key, size_t keylen, StrBuf *value, int save_to_server);
 718
 719 int is_msg_in_mset(char *mset, long msgnum);
 720 void display_addressbook(long msgnum, char alpha);
 721 void offer_start_page(void);
 722 void convenience_page(char *titlebarcolor, char *titlebarmsg, char *messagetext);
 723 void output_html(char *, int);
 724 void do_listsub(void);
 725 void toggle_self_service(void);
 726 ssize_t write(int fd, const void *buf, size_t count);
 727 void cal_process_attachment(char *part_source, long msgnum, char *cal_partnum);
 728 void display_calendar(long msgnum, int unread);
 729 void display_task(long msgnum, int unread);
 730 void display_note(long msgnum, int unread);
 731 void updatenote(void);
 732 void do_calendar_view(void);
 733 void do_tasks_view(void);
 734 void calendar_summary_view(void);
 735 int load_msg_ptrs(char *servcmd, int with_headers);
 736 void free_attachments(struct wcsession *sess);
 737 void free_march_list(struct wcsession *wcf);
 738 void display_rules_editor_inner_div(void);
 739 void generate_uuid(char *);
 740 void CtdlMakeTempFileName(char *, int);
 741 void address_book_popup(void);
 742 void begin_ajax_response(void);
 743 void end_ajax_response(void);
 744 void initialize_viewdefs(void);
 745 void initialize_axdefs(void);
 746 void burn_folder_cache(time_t age);
 747 void list_all_rooms_by_floor(const char *viewpref);
 748 void display_pictureview(void);
 749
 750 void display_edit_task(void);
 751 void display_edit_event(void);
 752 icaltimezone *get_default_icaltimezone(void);
 753 void display_icaltimetype_as_webform(struct icaltimetype *, char *);
 754 void icaltime_from_webform(struct icaltimetype *result, char *prefix);
 755 void icaltime_from_webform_dateonly(struct icaltimetype *result, char *prefix);
 756 void display_edit_individual_event(icalcomponent *supplied_vtodo, long msgnum, char *from, int unread);
 757 void save_individual_event(icalcomponent *supplied_vtodo, long msgnum, char *from, int unread);
 758 void ical_dezonify(icalcomponent *cal);
 759 void partstat_as_string(char *buf, icalproperty *attendee);
 760 icalcomponent *ical_encapsulate_subcomponent(icalcomponent *subcomp);
 761 void check_attendee_availability(icalcomponent *supplied_vevent);
 762 void do_freebusy(char *req);
 763 int ical_ctdl_is_overlap(
 764                         struct icaltimetype t1start,
 765                         struct icaltimetype t1end,
 766                         struct icaltimetype t2start,
 767                         struct icaltimetype t2end
 768 );
 769
 770 #ifdef ENABLE_NLS
 771 void initialize_locales(void);
 772 void ShutdownLocale(void);
 773 #endif
 774 void TmplGettext(StrBuf *Target, int nTokens, WCTemplateToken *Token);
 775
 776 extern char *months[];
 777 extern char *days[];
 778 int read_server_binary(StrBuf *Ret, size_t total_len);
 779 int StrBuf_ServGetBLOB(StrBuf *buf, long BlobSize);
 780 int read_server_text(StrBuf *Buf, long *nLines);;
 781 int goto_config_room(void);
 782 long locate_user_vcard(char *username, long usernum);
 783 void sleeeeeeeeeep(int);
 784 void http_transmit_thing(const char *content_type, int is_static);
 785 long unescape_input(char *buf);
 786 void do_selected_iconbar(void);
 787 int CtdlDecodeQuotedPrintable(char *decoded, char *encoded, int sourcelen);
 788 void spawn_another_worker_thread(void);
 789 void display_rss(char *roomname, char *request_method);
 790 void offer_languages(void);
 791 void set_selected_language(const char *);
 792 void go_selected_language(void);
 793 void stop_selected_language(void);
 794 void preset_locale(void);
 795 void httplang_to_locale(char *LocaleString);
 796 void tabbed_dialog(int num_tabs, char *tabnames[]);
 797 void begin_tab(int tabnum, int num_tabs);
 798 void end_tab(int tabnum, int num_tabs);
 799 void str_wiki_index(char *s);
 800 int get_time_format_cached (void);
 801 int xtoi(char *in, size_t len);
 802 void webcit_fmt_date(char *buf, time_t thetime, int brief);
 803 int fetch_http(char *url, char *target_buf, int maxbytes);
 804
 805 int is_mobile_ua(char *user_agent);
 806
 807 #ifdef HAVE_ICONV
 808 iconv_t ctdl_iconv_open(const char *tocode, const char *fromcode);
 809 #endif
 810
 811 void embed_room_banner(char *, int);
 812
 813 /* navbar types that can be passed to embed_room_banner */
 814 enum {
 815         navbar_none,
 816         navbar_default
 817 };
 818
 819
 820 #ifdef HAVE_OPENSSL
 821 void init_ssl(void);
 822 void endtls(void);
 823 void ssl_lock(int mode, int n, const char *file, int line);
 824 int starttls(int sock);
 825 extern SSL_CTX *ssl_ctx;
 826 int client_read_ssl(char *buf, int bytes, int timeout);
 827 void client_write_ssl(const char *buf, int nbytes);
 828 #endif
 829
 830 #ifdef HAVE_ZLIB
 831 #include <zlib.h>
 832 int ZEXPORT compress_gzip(Bytef * dest, size_t * destLen,
 833                           const Bytef * source, uLong sourceLen, int level);
 834 #endif
 835
 836 void utf8ify_rfc822_string(char *buf);
 837
 838 void begin_burst(void);
 839 long end_burst(void);
 840
 841 extern char *hourname[];        /**< Names of hours (12am, 1am, etc.) */
 842
 843 void http_datestring(char *buf, size_t n, time_t xtime);
 844
 845
 846 typedef void (*WebcitHandlerFunc)(void);
 847 typedef struct  _WebcitHandler{
 848         WebcitHandlerFunc F;
 849         long Flags;
 850 } WebcitHandler;
 851 void WebcitAddUrlHandler(const char * UrlString, long UrlSLen, WebcitHandlerFunc F, long Flags);
 852
 853 #define AJAX (1<<0)
 854 #define ANONYMOUS (1<<1)
 855 #define NEED_URL (1<<2)
 856
 857
 858 /* These should be empty, but we have them for testing */
 859 #define DEFAULT_HTTPAUTH_USER   ""
 860 #define DEFAULT_HTTPAUTH_PASS   ""
 861
 862
 863 /* Exit codes 101 through 109 are initialization failures so we don't want to
 864  * just keep respawning indefinitely.
 865  */
 866 #define WC_EXIT_BIND            101     /* Can't bind to the port */
 867 #define WC_EXIT_SSL             102     /* Can't initialize SSL */
 868
 869
 870 #define WC_TIMEFORMAT_NONE 0
 871 #define WC_TIMEFORMAT_AMPM 1
 872 #define WC_TIMEFORMAT_24 2
 873
 874