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