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