webcit/webcit.h

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