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