* add contexttype, so the subst can precheck the context pointer for us, and bad...
[citadel.git] / 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 #define TYPE_STR   1
258 #define TYPE_LONG  2
259 #define MAXPARAM  20
260 typedef struct _TemplateParam {
261         const char *Start;
262         int Type;
263         long len;
264         long lvalue;
265 } TemplateParam;
266
267 typedef struct _TemplateToken {
268         StrBuf *FlatToken;
269         long Line;
270         const char *pTokenStart;
271         size_t TokenStart;
272         size_t TokenEnd;
273         const char *pTokenEnd;
274         int Flags;
275         void *PreEval;
276
277         const char *pName;
278         size_t NameEnd;
279
280         int HaveParameters;
281         int nParameters;
282         TemplateParam *Params[MAXPARAM];
283 } WCTemplateToken;
284
285 typedef void (*WCHandlerFunc)(StrBuf *Target, int nArgs, WCTemplateToken *Token, void *Context, int ContextType);
286
287
288 /**
289  * \brief Dynamic content for variable substitution in templates
290  */
291 typedef struct _wcsubst {
292         int wcs_type;                       /**< which type of Substitution are we */
293         char wcs_key[32];                   /**< copy of our hashkey for debugging */
294         StrBuf *wcs_value;                  /**< if we're a string, keep it here */
295         long lvalue;                        /**< type long? keep data here */
296         int ContextRequired;                /**< do we require a context type? */
297         WCHandlerFunc wcs_function; /**< funcion hook ???*/
298 } wcsubst;
299
300 #define CTX_NONE 0
301 #define CTX_SITECFG 1
302 #define CTX_SESSION 2
303 #define CTX_INETCFG 3
304 #define CTX_VNOTE 4
305 #define CTX_WHO 5
306 #define CTX_PREF 6
307 #define CTX_NODECONF 7
308
309
310 void RegisterNS(const char *NSName, long len, 
311                 int nMinArgs, 
312                 int nMaxArgs, 
313                 WCHandlerFunc HandlerFunc,
314                 int ContextRequired);
315 #define RegisterNamespace(a, b, c, d, e) RegisterNS(a, sizeof(a)-1, b, c, d, e)
316
317 typedef int (*WCConditionalFunc)(WCTemplateToken *Token, void *Context, int ContextType);
318 typedef struct _ConditionalStruct {
319         int nParams;
320         int ContextRequired;
321         WCConditionalFunc CondF;
322 } ConditionalStruct;
323 void RegisterConditional(const char *Name, long len, 
324                          int nParams,
325                          WCConditionalFunc CondF, 
326                          int ContextRequired);
327
328
329
330 typedef void (*SubTemplFunc)(StrBuf *TemplBuffer, void *Context, WCTemplateToken *Token);
331 typedef HashList *(*RetrieveHashlistFunc)(WCTemplateToken *Token);
332 typedef void (*HashDestructorFunc) (HashList **KillMe);
333 void RegisterITERATOR(const char *Name, long len,
334                       int AdditionalParams, 
335                       HashList *StaticList, 
336                       RetrieveHashlistFunc GetHash, 
337                       SubTemplFunc DoSubTempl,
338                       HashDestructorFunc Destructor,
339                       int ContextType);
340 #define RegisterIterator(a, b, c, d, e, f, g) RegisterITERATOR(a, sizeof(a)-1, b, c, d, e, f, g)
341
342 void SVPut(char *keyname, size_t keylen, int keytype, char *Data);
343 #define svput(a, b, c) SVPut(a, sizeof(a) - 1, b, c)
344 void SVPutLong(char *keyname, size_t keylen, long Data);
345 #define svputlong(a, b) SVPutLong(a, sizeof(a) - 1, b)
346 void svprintf(char *keyname, size_t keylen, int keytype, const char *format,...) __attribute__((__format__(__printf__,4,5)));
347 void SVPRINTF(char *keyname, int keytype, const char *format,...) __attribute__((__format__(__printf__,3,4)));
348 void SVCALLBACK(char *keyname, WCHandlerFunc fcn_ptr);
349 void SVCallback(char *keyname, size_t keylen,  WCHandlerFunc fcn_ptr);
350 #define svcallback(a, b) SVCallback(a, sizeof(a) - 1, b)
351
352 void SVPUTBuf(const char *keyname, int keylen, const StrBuf *Buf, int ref);
353 #define SVPutBuf(a, b, c); SVPUTBuf(a, sizeof(a) - 1, b, c)
354
355 void DoTemplate(const char *templatename, long len, void *Context, StrBuf *Target, int ContextType);
356 #define do_template(a, b) DoTemplate(a, sizeof(a) -1, b, NULL, 0);
357 void url_do_template(void);
358
359 int CompareSubstToToken(TemplateParam *ParamToCompare, TemplateParam *ParamToLookup);
360 int CompareSubstToStrBuf(StrBuf *Compare, TemplateParam *ParamToLookup);
361
362
363
364
365 /**
366  * \brief Values for wcs_type
367  */
368 enum {
369         WCS_STRING,       /**< its a string */
370         WCS_FUNCTION,     /**< its a function callback */
371         WCS_SERVCMD,      /**< its a command to send to the citadel server */
372         WCS_STRBUF,       /**< its a strbuf we own */
373         WCS_STRBUF_REF,   /**< its a strbuf we mustn't free */
374         WCS_LONG          /**< its an integer */
375 };
376
377 /**
378  * \brief mail attachment ???
379  */
380 struct wc_attachment {
381         struct wc_attachment *next;/**< pointer to next in list */
382         size_t length;                     /**< length of the contenttype */
383         char content_type[SIZ];    /**< the content itself ???*/
384         char filename[SIZ];                /**< the filename hooked to this content ??? */
385         char *data;                /**< the data pool; aka this content */
386         long lvalue;               /**< if we put a long... */
387 };
388
389 /**
390  * \brief message summary structure. ???
391  */
392 struct message_summary {
393         time_t date;        /**< its creation date */
394         long msgnum;            /**< the message number on the citadel server */
395         char from[128];         /**< the author */
396         char to[128];           /**< the recipient */
397         char subj[256];         /**< the title / subject */
398         int hasattachments;     /**< does it have atachments? */
399         int is_new;         /**< is it yet read? */
400 };
401
402 /**
403  * \brief  Data structure for roomlist-to-folderlist conversion 
404  */
405 struct folder {
406         int floor;      /**< which floor is it on */
407         char room[SIZ]; /**< which roomname ??? */
408         char name[SIZ]; /**< which is its own name??? */
409         int hasnewmsgs; /**< are there unread messages inside */
410         int is_mailbox; /**< is it a mailbox?  */
411         int selectable; /**< can we select it ??? */
412         int view;       /**< whats its default view? inbox/calendar.... */
413         int num_rooms;  /**< If this is a floor, how many rooms does it have */
414 };
415
416 typedef struct _disp_cal {                                      
417         icalcomponent *cal;             /**< cal items for display */
418         long cal_msgnum;                /**< cal msgids for display */
419         char *from;                     /**< owner of this component */
420         int unread;                     /**< already seen by the user? */
421
422         time_t event_start;
423         time_t event_end;
424
425         int multi_day_event;
426         int is_repeat;
427 } disp_cal;                                             
428
429
430 /**
431  * \brief One of these is kept for each active Citadel session.
432  * HTTP transactions are bound to on e at a time.
433  */
434 struct wcsession {
435         struct wcsession *next;                 /**< Linked list */
436         int wc_session;                         /**< WebCit session ID */
437         char wc_username[128];                  /**< login name of current user */
438         char wc_fullname[128];                  /**< Screen name of current user */
439         char wc_password[128];                  /**< Password of current user */
440         char wc_roomname[256];                  /**< Room we are currently in */
441         int connected;                          /**< nonzero == we are connected to Citadel */
442         int logged_in;                          /**< nonzero == we are logged in  */
443         int axlevel;                            /**< this user's access level */
444         int is_aide;                            /**< nonzero == this user is an Aide */
445         int is_room_aide;                       /**< nonzero == this user is a Room Aide in this room */
446         int http_sock;                          /**< HTTP server socket */
447         int serv_sock;                          /**< Client socket to Citadel server */
448         int chat_sock;                          /**< Client socket to Citadel server - for chat */
449         unsigned room_flags;                    /**< flags associated with the current room */
450         unsigned room_flags2;                   /**< flags associated with the current room */
451         int wc_view;                            /**< view for the current room */
452         int wc_default_view;                    /**< default view for the current room */
453         int wc_is_trash;                        /**< nonzero == current room is a Trash folder */
454         int wc_floor;                           /**< floor number of current room */
455         char ugname[128];                       /**< where does 'ungoto' take us */
456         long uglsn;                             /**< last seen message number for ungoto */
457         int upload_length;                      /**< content length of http-uploaded data */
458         char *upload;                           /**< pointer to http-uploaded data */
459         char upload_filename[PATH_MAX];         /**< filename of http-uploaded data */
460         char upload_content_type[256];          /**< content type of http-uploaded data */
461         int new_mail;                           /**< user has new mail waiting */
462         int remember_new_mail;                  /**< last count of new mail messages */
463         int need_regi;                          /**< This user needs to register. */
464         int need_vali;                          /**< New users require validation. */
465         char cs_inet_email[256];                /**< User's preferred Internet addr. */
466         pthread_mutex_t SessionMutex;           /**< mutex for exclusive access */
467         time_t lastreq;                         /**< Timestamp of most recent HTTP */
468         int killthis;                           /**< Nonzero == purge this session */
469         struct march *march;                    /**< march mode room list */
470         char reply_to[512];                     /**< reply-to address */
471         long msgarr[10000];                     /**< for read operations */
472         int num_summ;                           /**< number of messages in mailbox summary view */
473         struct message_summary *summ;           /**< array of messages for mailbox summary view */
474         int is_mobile;                  /**< Client is a handheld browser */
475         HashList *urlstrings;                   /**< variables passed to webcit in a URL */
476         HashList *vars;                         /**< HTTP variable substitutions for this page */
477         char this_page[512];                    /**< URL of current page */
478         char http_host[512];                    /**< HTTP Host: header */
479         HashList *hash_prefs;                   /**< WebCit preferences for this user */
480         HashList *disp_cal_items;               /**< sorted list of calendar items; startdate is the sort criteria. */
481         struct wc_attachment *first_attachment; /**< linked list of attachments for 'enter message' */
482         char last_chat_user[256];               /**< ??? todo */
483         char ImportantMessage[SIZ];             /**< ??? todo */
484         int ctdl_pid;                           /**< Session ID on the Citadel server */
485         char httpauth_user[256];                /**< only for GroupDAV sessions */
486         char httpauth_pass[256];                /**< only for GroupDAV sessions */
487         int gzip_ok;                            /**< Nonzero if Accept-encoding: gzip */
488         int is_mailbox;                         /**< the current room is a private mailbox */
489         struct folder *cache_fold;              /**< cache the iconbar room list */
490         int cache_max_folders;                  /**< ??? todo */
491         int cache_num_floors;                   /**< ??? todo */
492         time_t cache_timestamp;                 /**< ??? todo */
493         HashList *IconBarSetttings;             /**< which icons should be shown / not shown? */
494         long current_iconbar;                   /**< What is currently in the iconbar? */
495         const StrBuf *floordiv_expanded;        /**< which floordiv currently expanded */
496         int selected_language;                  /**< Language selected by user */
497         time_t last_pager_check;                /**< last time we polled for instant msgs */
498         int nonce;                              /**< session nonce (to prevent session riding) */
499         int time_format_cache;                  /**< which timeformat does our user like? */
500         StrBuf *UrlFragment1;                   /**< first urlfragment, if NEED_URL is specified by the handler*/
501         StrBuf *UrlFragment2;                   /**< second urlfragment, if NEED_URL is specified by the handler*/
502         StrBuf *WBuf;                           /**< Our output buffer */
503         StrBuf *HBuf;                           /**< Our HeaderBuffer */
504         StrBuf *CLineBuf;                       /**< linebuffering client stuff */
505
506         HashList *ServCfg;                      /**< cache our server config for editing */
507         HashList *InetCfg;                      /**< Our inet server config for editing */
508 };
509
510 /** values for WC->current_iconbar */
511 enum {
512         current_iconbar_menu,     /**< view the icon menue */
513         current_iconbar_roomlist  /**< view the roomtree */
514 };
515 enum {
516         S_SELECT,
517         S_SHUTDOWN,
518         MAX_SEMAPHORES
519 };
520
521 #ifndef num_parms
522 #define num_parms(source)               num_tokens(source, '|') 
523 #endif
524
525 /* Per-session data */
526 #define WC ((struct wcsession *)pthread_getspecific(MyConKey))
527 extern pthread_key_t MyConKey;
528
529 /* Per-thread SSL context */
530 #ifdef HAVE_OPENSSL
531 #define THREADSSL ((SSL *)pthread_getspecific(ThreadSSL))
532 extern pthread_key_t ThreadSSL;
533 extern char ctdl_key_dir[PATH_MAX];
534 extern char file_crpt_file_key[PATH_MAX];
535 extern char file_crpt_file_csr[PATH_MAX];
536 extern char file_crpt_file_cer[PATH_MAX];
537 #endif
538
539 struct serv_info serv_info;
540 extern char floorlist[128][SIZ];
541 extern char *axdefs[];
542 extern char *ctdlhost, *ctdlport;
543 extern int http_port;
544 extern char *server_cookie;
545 extern int is_https;
546 extern int setup_wizard;
547 extern char wizard_filename[];
548 extern time_t if_modified_since;
549 extern int follow_xff;
550 extern HashList *HandlerHash;
551 extern HashList *PreferenceHooks;
552 extern HashList *WirelessTemplateCache;
553 extern HashList *WirelessLocalTemplateCache;
554 extern HashList *TemplateCache;
555 extern HashList *LocalTemplateCache;
556 extern HashList *GlobalNS;
557 extern HashList *Iterators;
558 extern HashList *ZoneHash;
559 extern HashList *Contitionals;
560
561
562 void InitialiseSemaphores(void);
563 void begin_critical_section(int which_one);
564 void end_critical_section(int which_one);
565
566
567 void stuff_to_cookie(char *cookie, size_t clen, int session,
568                         char *user, char *pass, char *room);
569 void cookie_to_stuff(StrBuf *cookie, int *session,
570                 char *user, size_t user_len,
571                 char *pass, size_t pass_len,
572                 char *room, size_t room_len);
573 void locate_host(char *, int);
574 void become_logged_in(char *, char *, char *);
575 void openid_manual_create(void);
576 void display_login(char *mesg);
577 void display_openids(void);
578 void do_welcome(void);
579 void do_logout(void);
580 void display_main_menu(void);
581 void display_aide_menu(void);
582 void display_advanced_menu(void);
583 void slrp_highest(void);
584 void get_serv_info(char *, char *);
585 int uds_connectsock(char *);
586 int tcp_connectsock(char *, char *);
587 int serv_getln(char *strbuf, int bufsize);
588 int StrBuf_ServGetln(StrBuf *buf);
589 void serv_puts(const char *string);
590 void who(void);
591 void who_inner_div(void);
592 void ajax_mini_calendar(void);
593 void fmout(char *align);
594 void _fmout(StrBuf *Targt, char *align);
595 void pullquote_fmout(void);
596 void wDumpContent(int);
597
598 /* These may return NULL if not foud */
599 #define sbstr(a) SBstr(a, sizeof(a) - 1)
600 const StrBuf *SBSTR(const char *key);
601 const StrBuf *SBstr(const char *key, size_t keylen);
602
603 #define xbstr(a, b) (char*) XBstr(a, sizeof(a) - 1, b)
604 const char *XBstr(const char *key, size_t keylen, size_t *len);
605 const char *XBSTR(const char *key, size_t *len);
606
607 #define lbstr(a) LBstr(a, sizeof(a) - 1)
608 long LBstr(const char *key, size_t keylen);
609 long LBSTR(const char *key);
610
611 #define ibstr(a) IBstr(a, sizeof(a) - 1)
612 int IBstr(const char *key, size_t keylen);
613 int IBSTR(const char *key);
614
615 #define havebstr(a) HaveBstr(a, sizeof(a) - 1)
616 int HaveBstr(const char *key, size_t keylen);
617 int HAVEBSTR(const char *key);
618
619 #define yesbstr(a) YesBstr(a, sizeof(a) - 1)
620 int YesBstr(const char *key, size_t keylen);
621 int YESBSTR(const char *key);
622
623 /* TODO: get rid of the non-const-typecast */
624 #define bstr(a) (char*) Bstr(a, sizeof(a) - 1)
625 const char *BSTR(const char *key);
626 const char *Bstr(const char *key, size_t keylen);
627
628
629
630 void UrlescPutStrBuf(const StrBuf *strbuf);
631 void StrEscPuts(const StrBuf *strbuf);
632 void StrEscputs1(const StrBuf *strbuf, int nbsp, int nolinebreaks);
633
634 void urlescputs(const char *);
635 void hurlescputs(const char *);
636 void jsesc(char *, size_t, char *);
637 void jsescputs(char *);
638 void output_headers(    int do_httpheaders,
639                         int do_htmlhead,
640                         int do_room_banner,
641                         int unset_cookies,
642                         int suppress_check,
643                         int cache);
644 void wprintf(const char *format,...)__attribute__((__format__(__printf__,1,2)));
645 void hprintf(const char *format,...)__attribute__((__format__(__printf__,1,2)));
646 void output_static(char *what);
647 void display_mime_icon(void);
648 void print_menu_box(char* Title, char *Class, int nLines, ...);
649 long stresc(char *target, long tSize, char *strbuf, int nbsp, int nolinebreaks);
650 void escputs(char *strbuf);
651 void url(char *buf, size_t bufsize);
652 void escputs1(char *strbuf, int nbsp, int nolinebreaks);
653 void msgesc(char *target, size_t tlen, char *strbuf);
654 void msgescputs(char *strbuf);
655 void msgescputs1(char *strbuf);
656 void stripout(char *str, char leftboundary, char rightboundary);
657 void dump_vars(void);
658 void embed_main_menu(void);
659 void serv_read(char *buf, int bytes);
660 void readloop(char *oper);
661 void read_message(long msgnum, int printable_view, char *section);
662 void text_to_server(char *ptr);
663 void text_to_server_qp(char *ptr);
664 void confirm_delete_msg(void);
665 void display_success(char *);
666 void authorization_required(const char *message);
667 void server_to_text(void);
668 void save_edit(char *description, char *enter_cmd, int regoto);
669 void display_edit(char *description, char *check_cmd,
670                   char *read_cmd, char *save_cmd, int with_room_banner);
671 int gotoroom(char *gname);
672 void confirm_delete_room(void);
673 void validate(void);
674 void display_graphics_upload(char *, char *, char *);
675 void do_graphics_upload(char *upl_cmd);
676 void serv_read(char *buf, int bytes);
677 void serv_gets(char *strbuf);
678 void serv_write(const char *buf, int nbytes);
679 void serv_puts(const char *string);
680 void serv_putbuf(const StrBuf *string);
681 void serv_printf(const char *format,...)__attribute__((__format__(__printf__,1,2)));
682 void load_floorlist(void);
683 void shutdown_sessions(void);
684 void do_housekeeping(void);
685 void smart_goto(char *);
686 void worker_entry(void);
687 void session_loop(HashList *HTTPHeaders, StrBuf *ReqLine, StrBuf *ReqType, StrBuf *ReadBuf);
688 size_t wc_strftime(char *s, size_t max, const char *format, const struct tm *tm);
689 void fmt_time(char *buf, time_t thetime);
690 void httpdate(char *buf, time_t thetime);
691 time_t httpdate_to_timestamp(StrBuf *buf);
692 void end_webcit_session(void);
693 void page_popup(void);
694 void http_redirect(const char *);
695 void clear_substs(struct wcsession *wc);
696 void clear_local_substs(void);
697
698
699
700 int lingering_close(int fd);
701 char *memreadline(char *start, char *buf, int maxlen);
702 char *memreadlinelen(char *start, char *buf, int maxlen, int *retlen);
703 long extract_token(char *dest, const char *source, int parmnum, char separator, int maxlen);
704 void remove_token(char *source, int parmnum, char separator);
705 char *load_mimepart(long msgnum, char *partnum);
706 int pattern2(char *search, char *patn);
707 void do_edit_vcard(long, char *, char *, char *);
708 void striplt(char *);
709 void stripltlen(char *, int *);
710 void select_user_to_edit(char *message, char *preselect);
711 void delete_user(char *);
712 void do_change_view(int);
713 void folders(void);
714
715
716 void load_preferences(void);
717 void save_preferences(void);
718 #define get_preference(a, b) get_PREFERENCE(a, sizeof(a) - 1, b)
719 #define get_pref(a, b)       get_PREFERENCE(ChrPtr(a), StrLength(a), b)
720 int get_PREFERENCE(const char *key, size_t keylen, StrBuf **value);
721 #define set_preference(a, b, c) set_PREFERENCE(a, sizeof(a) - 1, b, c)
722 #define set_pref(a, b, c)       set_PREFERENCE(ChrPtr(a), StrLength(a), b, c)
723 void set_PREFERENCE(const char *key, size_t keylen, StrBuf *value, int save_to_server);
724
725 #define get_pref_long(a, b, c) get_PREF_LONG(a, sizeof(a) - 1, b, c)
726 int get_PREF_LONG(const char *key, size_t keylen, long *value, long Default);
727 #define set_pref_long(a, b, c) set_PREF_LONG(a, sizeof(a) - 1, b, c)
728 void set_PREF_LONG(const char *key, size_t keylen, long value, int save_to_server);
729
730 #define get_pref_yesno(a, b, c) get_PREF_YESNO(a, sizeof(a) - 1, b, c)
731 int get_PREF_YESNO(const char *key, size_t keylen, int *value, int Default);
732 #define set_pref_yesno(a, b, c) set_PREF_YESNO(a, sizeof(a) - 1, b, c)
733 void set_PREF_YESNO(const char *key, size_t keylen, int value, int save_to_server);
734
735 #define get_room_pref(a) get_ROOM_PREFS(a, sizeof(a) - 1)
736 StrBuf *get_ROOM_PREFS(const char *key, size_t keylen);
737
738 #define set_room_pref(a, b, c) set_ROOM_PREFS(a, sizeof(a) - 1, b, c)
739 void set_ROOM_PREFS(const char *key, size_t keylen, StrBuf *value, int save_to_server);
740
741 int is_msg_in_mset(char *mset, long msgnum);
742 void display_addressbook(long msgnum, char alpha);
743 void offer_start_page(StrBuf *Target, int nArgs, WCTemplateToken *Token, void *Context, int ContextType);
744 void convenience_page(char *titlebarcolor, char *titlebarmsg, char *messagetext);
745 void output_html(char *, int);
746 void do_listsub(void);
747 void toggle_self_service(void);
748 ssize_t write(int fd, const void *buf, size_t count);
749 void cal_process_attachment(char *part_source, long msgnum, char *cal_partnum);
750 void display_calendar(long msgnum, int unread);
751 void display_task(long msgnum, int unread);
752 void display_note(long msgnum, int unread);
753 void updatenote(void);
754 void do_calendar_view(void);
755 void do_tasks_view(void);
756 void calendar_summary_view(void);
757 int load_msg_ptrs(char *servcmd, int with_headers);
758 void free_attachments(struct wcsession *sess);
759 void free_march_list(struct wcsession *wcf);
760 void display_rules_editor_inner_div(void);
761 void generate_uuid(char *);
762 void CtdlMakeTempFileName(char *, int);
763 void address_book_popup(void);
764 void begin_ajax_response(void);
765 void end_ajax_response(void);
766 void initialize_viewdefs(void);
767 void initialize_axdefs(void);
768 void burn_folder_cache(time_t age);
769 void list_all_rooms_by_floor(const char *viewpref);
770 void display_pictureview(void);
771
772 void display_edit_task(void);
773 void display_edit_event(void);
774 icaltimezone *get_default_icaltimezone(void);
775 void display_icaltimetype_as_webform(struct icaltimetype *, char *);
776 void icaltime_from_webform(struct icaltimetype *result, char *prefix);
777 void icaltime_from_webform_dateonly(struct icaltimetype *result, char *prefix);
778 void display_edit_individual_event(icalcomponent *supplied_vtodo, long msgnum, char *from, int unread);
779 void save_individual_event(icalcomponent *supplied_vtodo, long msgnum, char *from, int unread);
780 void ical_dezonify(icalcomponent *cal);
781 void partstat_as_string(char *buf, icalproperty *attendee);
782 icalcomponent *ical_encapsulate_subcomponent(icalcomponent *subcomp);
783 void check_attendee_availability(icalcomponent *supplied_vevent);
784 void do_freebusy(const char *req);
785 int ical_ctdl_is_overlap(
786                         struct icaltimetype t1start,
787                         struct icaltimetype t1end,
788                         struct icaltimetype t2start,
789                         struct icaltimetype t2end
790 );
791
792 #ifdef ENABLE_NLS
793 void initialize_locales(void);
794 void ShutdownLocale(void);
795 #endif
796 void TmplGettext(StrBuf *Target, int nTokens, WCTemplateToken *Token);
797
798 extern char *months[];
799 extern char *days[];
800 int read_server_binary(StrBuf *Ret, size_t total_len);
801 int StrBuf_ServGetBLOB(StrBuf *buf, long BlobSize);
802 int read_server_text(StrBuf *Buf, long *nLines);;
803 int goto_config_room(void);
804 long locate_user_vcard(char *username, long usernum);
805 void sleeeeeeeeeep(int);
806 void http_transmit_thing(const char *content_type, int is_static);
807 long unescape_input(char *buf);
808 void do_selected_iconbar(void);
809 int CtdlDecodeQuotedPrintable(char *decoded, char *encoded, int sourcelen);
810 void spawn_another_worker_thread(void);
811 void display_rss(char *roomname, StrBuf *request_method);
812 void offer_languages(StrBuf *Target, int nArgs, WCTemplateToken *Token, void *Context, int ContextType);
813 void set_selected_language(const char *);
814 void go_selected_language(void);
815 void stop_selected_language(void);
816 void preset_locale(void);
817 void httplang_to_locale(StrBuf *LocaleString);
818 void StrEndTab(StrBuf *Target, int tabnum, int num_tabs);
819 void StrBeginTab(StrBuf *Target, int tabnum, int num_tabs);
820 void StrTabbedDialog(StrBuf *Target, int num_tabs, StrBuf *tabnames[]);
821 void tabbed_dialog(int num_tabs, char *tabnames[]);
822 void begin_tab(int tabnum, int num_tabs);
823 void end_tab(int tabnum, int num_tabs);
824 void str_wiki_index(char *s);
825 int get_time_format_cached (void);
826 int xtoi(const char *in, size_t len);
827 void webcit_fmt_date(char *buf, time_t thetime, int brief);
828 int fetch_http(char *url, char *target_buf, int maxbytes);
829
830 int is_mobile_ua(char *user_agent);
831
832 #ifdef HAVE_ICONV
833 iconv_t ctdl_iconv_open(const char *tocode, const char *fromcode);
834 #endif
835
836 void embed_room_banner(char *, int);
837
838 /* navbar types that can be passed to embed_room_banner */
839 enum {
840         navbar_none,
841         navbar_default
842 };
843
844
845 #ifdef HAVE_OPENSSL
846 void init_ssl(void);
847 void endtls(void);
848 void ssl_lock(int mode, int n, const char *file, int line);
849 int starttls(int sock);
850 extern SSL_CTX *ssl_ctx;  
851 int client_read_sslbuffer(StrBuf *buf, int timeout);
852 void client_write_ssl(const StrBuf *Buf);
853 #endif
854
855 #ifdef HAVE_ZLIB
856 #include <zlib.h>
857 int ZEXPORT compress_gzip(Bytef * dest, size_t * destLen,
858                           const Bytef * source, uLong sourceLen, int level);
859 #endif
860
861 void utf8ify_rfc822_string(char *buf);
862
863 void begin_burst(void);
864 long end_burst(void);
865
866 extern char *hourname[];        /**< Names of hours (12am, 1am, etc.) */
867
868 void http_datestring(char *buf, size_t n, time_t xtime);
869
870
871 typedef void (*WebcitHandlerFunc)(void);
872 typedef struct  _WebcitHandler{
873         WebcitHandlerFunc F;
874         long Flags;
875 } WebcitHandler;
876 void WebcitAddUrlHandler(const char * UrlString, long UrlSLen, WebcitHandlerFunc F, long Flags);
877
878 #define AJAX (1<<0)
879 #define ANONYMOUS (1<<1)
880 #define NEED_URL (1<<2)
881
882
883 /* These should be empty, but we have them for testing */
884 #define DEFAULT_HTTPAUTH_USER   ""
885 #define DEFAULT_HTTPAUTH_PASS   ""
886
887
888 /* Exit codes 101 through 109 are initialization failures so we don't want to
889  * just keep respawning indefinitely.
890  */
891 #define WC_EXIT_BIND            101     /* Can't bind to the port */
892 #define WC_EXIT_SSL             102     /* Can't initialize SSL */
893
894
895 #define WC_TIMEFORMAT_NONE 0
896 #define WC_TIMEFORMAT_AMPM 1
897 #define WC_TIMEFORMAT_24 2
898
899