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