* use strbuffer as wprintf backend
[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         char *url_data;            /**< its value */
232         size_t url_data_size;      /**< how big is it? */
233 };
234
235 /**
236  * \brief information about us ???
237  */ 
238 struct serv_info {
239         int serv_pid;                   /* Process ID of the Citadel server */
240         char serv_nodename[32];         /* Node name of the Citadel server */
241         char serv_humannode[64];        /* human readable node name of the Citadel server */
242         char serv_fqdn[64];             /* fully quallified Domain Name (such as uncensored.citadel.org) */
243         char serv_software[64];         /* What version does our connected citadel server use */
244         int serv_rev_level;             /* Whats the citadel server revision */
245         char serv_bbs_city[64];         /* Geographic location of the Citadel server */
246         char serv_sysadm[64];           /* Name of system administrator */
247         char serv_moreprompt[256];      /* Whats the commandline textprompt */
248         int serv_ok_floors;             /* nonzero == server supports floors */
249         int serv_supports_ldap;         /* is the server linked against an ldap tree for adresses? */
250         int serv_newuser_disabled;      /* Has the server disabled self-service new user creation? */
251         char serv_default_cal_zone[128];/* Default timezone for unspecified calendar items */
252         int serv_supports_sieve;        /* Does the server support Sieve mail filtering? */
253         int serv_fulltext_enabled;      /* Does the server have the full text index enabled? */
254         char serv_svn_revision[256];    /* SVN revision of the server */
255         int serv_supports_openid;       /* Does the server support authentication via OpenID? */
256 };
257
258
259
260 /**
261  * \brief This struct holds a list of rooms for \\\<G\\\>oto operations.
262  */
263 struct march {
264         struct march *next;       /**< pointer to next in linked list */
265         char march_name[128];     /**< name of room */
266         int march_floor;          /**< floor number of room */
267         int march_order;          /**< sequence in which we are to visit this room */
268 };
269
270 /* *
271  * \brief       This struct holds a list of rooms for client display.
272  *              It is a binary tree.
273  */
274 struct roomlisting {
275         struct roomlisting *lnext;      /**< pointer to 'left' tree node */
276         struct roomlisting *rnext;      /**< pointer to 'right' tree node */
277         char rlname[128];               /**< name of room */
278         unsigned rlflags;               /**< room flags */
279         int rlfloor;                    /**< the floor it resides on */
280         int rlorder;                    /**< room listing order */
281 };
282
283
284
285 /**
286  * \brief Dynamic content for variable substitution in templates
287  */
288 typedef struct _wcsubst {
289         int wcs_type;                       /**< which type of ??? */
290         char wcs_key[32];                   /**< ??? what?*/
291         void *wcs_value;                    /**< ???? what?*/
292         void (*wcs_function)(void); /**< funcion hook ???*/
293 } wcsubst;
294
295 /**
296  * \brief Values for wcs_type
297  */
298 enum {
299         WCS_STRING,   /**< its a string */
300         WCS_FUNCTION, /**< its a function callback */
301         WCS_SERVCMD   /**< its a command to send to the citadel server */
302 };
303
304 /**
305  * \brief mail attachment ???
306  */
307 struct wc_attachment {
308         struct wc_attachment *next;/**< pointer to next in list */
309         size_t length;                     /**< length of the contenttype */
310         char content_type[SIZ];    /**< the content itself ???*/
311         char filename[SIZ];                /**< the filename hooked to this content ??? */
312         char *data;                /**< the data pool; aka this content */
313 };
314
315 /**
316  * \brief message summary structure. ???
317  */
318 struct message_summary {
319         time_t date;        /**< its creation date */
320         long msgnum;            /**< the message number on the citadel server */
321         char from[128];         /**< the author */
322         char to[128];           /**< the recipient */
323         char subj[256];         /**< the title / subject */
324         int hasattachments;     /**< does it have atachments? */
325         int is_new;         /**< is it yet read? */
326 };
327
328 /**
329  * \brief  Data structure for roomlist-to-folderlist conversion 
330  */
331 struct folder {
332         int floor;      /**< which floor is it on */
333         char room[SIZ]; /**< which roomname ??? */
334         char name[SIZ]; /**< which is its own name??? */
335         int hasnewmsgs; /**< are there unread messages inside */
336         int is_mailbox; /**< is it a mailbox?  */
337         int selectable; /**< can we select it ??? */
338         int view;       /**< whats its default view? inbox/calendar.... */
339         int num_rooms;  /**< If this is a floor, how many rooms does it have */
340 };
341
342 typedef struct _disp_cal {                                      
343         icalcomponent *cal;             /**< cal items for display */
344         long cal_msgnum;                /**< cal msgids for display */
345         char *from;                     /**< owner of this component */
346         int unread;                     /**< already seen by the user? */
347
348         time_t event_start;
349         time_t event_end;
350
351         int multi_day_event;
352         int is_repeat;
353 } disp_cal;                                             
354
355
356 /**
357  * \brief One of these is kept for each active Citadel session.
358  * HTTP transactions are bound to on e at a time.
359  */
360 struct wcsession {
361         struct wcsession *next;                 /**< Linked list */
362         int wc_session;                         /**< WebCit session ID */
363         char wc_username[128];                  /**< login name of current user */
364         char wc_fullname[128];                  /**< Screen name of current user */
365         char wc_password[128];                  /**< Password of current user */
366         char wc_roomname[256];                  /**< Room we are currently in */
367         int connected;                          /**< nonzero == we are connected to Citadel */
368         int logged_in;                          /**< nonzero == we are logged in  */
369         int axlevel;                            /**< this user's access level */
370         int is_aide;                            /**< nonzero == this user is an Aide */
371         int is_room_aide;                       /**< nonzero == this user is a Room Aide in this room */
372         int http_sock;                          /**< HTTP server socket */
373         int serv_sock;                          /**< Client socket to Citadel server */
374         int chat_sock;                          /**< Client socket to Citadel server - for chat */
375         unsigned room_flags;                    /**< flags associated with the current room */
376         unsigned room_flags2;                   /**< flags associated with the current room */
377         int wc_view;                            /**< view for the current room */
378         int wc_default_view;                    /**< default view for the current room */
379         int wc_is_trash;                        /**< nonzero == current room is a Trash folder */
380         int wc_floor;                           /**< floor number of current room */
381         char ugname[128];                       /**< where does 'ungoto' take us */
382         long uglsn;                             /**< last seen message number for ungoto */
383         int upload_length;                      /**< content length of http-uploaded data */
384         char *upload;                           /**< pointer to http-uploaded data */
385         char upload_filename[PATH_MAX];         /**< filename of http-uploaded data */
386         char upload_content_type[256];          /**< content type of http-uploaded data */
387         int new_mail;                           /**< user has new mail waiting */
388         int remember_new_mail;                  /**< last count of new mail messages */
389         int need_regi;                          /**< This user needs to register. */
390         int need_vali;                          /**< New users require validation. */
391         char cs_inet_email[256];                /**< User's preferred Internet addr. */
392         pthread_mutex_t SessionMutex;           /**< mutex for exclusive access */
393         time_t lastreq;                         /**< Timestamp of most recent HTTP */
394         int killthis;                           /**< Nonzero == purge this session */
395         struct march *march;                    /**< march mode room list */
396         char reply_to[512];                     /**< reply-to address */
397         long msgarr[10000];                     /**< for read operations */
398         int num_summ;                           /**< number of messages in mailbox summary view */
399         struct message_summary *summ;           /**< array of messages for mailbox summary view */
400         int is_mobile;                  /**< Client is a handheld browser */
401         HashList *urlstrings;                   /**< variables passed to webcit in a URL */
402         HashList *vars;                         /**< HTTP variable substitutions for this page */
403         char this_page[512];                    /**< URL of current page */
404         char http_host[512];                    /**< HTTP Host: header */
405         HashList *hash_prefs;                   /**< WebCit preferences for this user */
406         HashList *disp_cal_items;               /**< sorted list of calendar items; startdate is the sort criteria. */
407         struct wc_attachment *first_attachment; /**< linked list of attachments for 'enter message' */
408         char last_chat_user[256];               /**< ??? todo */
409         char ImportantMessage[SIZ];             /**< ??? todo */
410         int ctdl_pid;                           /**< Session ID on the Citadel server */
411         char httpauth_user[256];                /**< only for GroupDAV sessions */
412         char httpauth_pass[256];                /**< only for GroupDAV sessions */
413         int gzip_ok;                            /**< Nonzero if Accept-encoding: gzip */
414         int is_mailbox;                         /**< the current room is a private mailbox */
415         struct folder *cache_fold;              /**< cache the iconbar room list */
416         int cache_max_folders;                  /**< ??? todo */
417         int cache_num_floors;                   /**< ??? todo */
418         time_t cache_timestamp;                 /**< ??? todo */
419         HashList *IconBarSetttings;             /**< which icons should be shown / not shown? */
420         long current_iconbar;                   /**< What is currently in the iconbar? */
421         StrBuf *floordiv_expanded;              /**< which floordiv currently expanded */
422         int selected_language;                  /**< Language selected by user */
423         time_t last_pager_check;                /**< last time we polled for instant msgs */
424         int nonce;                              /**< session nonce (to prevent session riding) */
425         int time_format_cache;                  /**< which timeformat does our user like? */
426         StrBuf *UrlFragment1;                   /**< first urlfragment, if NEED_URL is specified by the handler*/
427         StrBuf *UrlFragment2;                   /**< second urlfragment, if NEED_URL is specified by the handler*/
428         StrBuf *WBuf;                           /**< Our output buffer */
429         StrBuf *HBuf;                           /**< Our HeaderBuffer */
430 };
431
432 /** values for WC->current_iconbar */
433 enum {
434         current_iconbar_menu,     /**< view the icon menue */
435         current_iconbar_roomlist  /**< view the roomtree */
436 };
437 enum {
438         S_SELECT,
439         S_SHUTDOWN,
440         MAX_SEMAPHORES
441 };
442
443 #ifndef num_parms
444 #define num_parms(source)               num_tokens(source, '|') 
445 #endif
446
447 /* Per-session data */
448 #define WC ((struct wcsession *)pthread_getspecific(MyConKey))
449 extern pthread_key_t MyConKey;
450
451 /* Per-thread SSL context */
452 #ifdef HAVE_OPENSSL
453 #define THREADSSL ((SSL *)pthread_getspecific(ThreadSSL))
454 extern pthread_key_t ThreadSSL;
455 extern char ctdl_key_dir[PATH_MAX];
456 extern char file_crpt_file_key[PATH_MAX];
457 extern char file_crpt_file_csr[PATH_MAX];
458 extern char file_crpt_file_cer[PATH_MAX];
459 #endif
460
461 struct serv_info serv_info;
462 extern char floorlist[128][SIZ];
463 extern char *axdefs[];
464 extern char *ctdlhost, *ctdlport;
465 extern int http_port;
466 extern char *server_cookie;
467 extern int is_https;
468 extern int setup_wizard;
469 extern char wizard_filename[];
470 extern time_t if_modified_since;
471 extern int follow_xff;
472 extern HashList *HandlerHash;
473
474 void InitialiseSemaphores(void);
475 void begin_critical_section(int which_one);
476 void end_critical_section(int which_one);
477
478
479 void stuff_to_cookie(char *cookie, size_t clen, int session,
480                         char *user, char *pass, char *room);
481 void cookie_to_stuff(char *cookie, int *session,
482                 char *user, size_t user_len,
483                 char *pass, size_t pass_len,
484                 char *room, size_t room_len);
485 void locate_host(char *, int);
486 void become_logged_in(char *, char *, char *);
487 void openid_manual_create(void);
488 void display_login(char *mesg);
489 void display_openids(void);
490 void do_welcome(void);
491 void do_logout(void);
492 void display_main_menu(void);
493 void display_aide_menu(void);
494 void display_advanced_menu(void);
495 void slrp_highest(void);
496 void get_serv_info(char *, char *);
497 int uds_connectsock(char *);
498 int tcp_connectsock(char *, char *);
499 int serv_getln(char *strbuf, int bufsize);
500 int StrBuf_ServGetln(StrBuf *buf);
501 void serv_puts(char *string);
502 void who(void);
503 void who_inner_div(void);
504 void ajax_mini_calendar(void);
505 void fmout(char *align);
506 void pullquote_fmout(void);
507 void wDumpContent(int);
508
509 /* TODO: get rid of the non-const-typecast */
510 #define bstr(a) (char*) Bstr(a, sizeof(a) - 1)
511 const char *BSTR(char *key);
512 const char *Bstr(char *key, size_t keylen);
513
514 #define xbstr(a, b) (char*) XBstr(a, sizeof(a) - 1, b)
515 const char *XBstr(char *key, size_t keylen, size_t *len);
516 const char *XBSTR(char *key, size_t *len);
517
518 #define lbstr(a) LBstr(a, sizeof(a) - 1)
519 long LBstr(char *key, size_t keylen);
520 long LBSTR(char *key);
521
522 #define ibstr(a) IBstr(a, sizeof(a) - 1)
523 int IBstr(char *key, size_t keylen);
524 int IBSTR(char *key);
525
526 #define havebstr(a) HaveBstr(a, sizeof(a) - 1)
527 int HaveBstr(char *key, size_t keylen);
528 int HAVEBSTR(char *key);
529
530 #define yesbstr(a) YesBstr(a, sizeof(a) - 1)
531 int YesBstr(char *key, size_t keylen);
532 int YESBSTR(char *key);
533
534
535 void urlescputs(char *);
536 void jsesc(char *, size_t, char *);
537 void jsescputs(char *);
538 void output_headers(    int do_httpheaders,
539                         int do_htmlhead,
540                         int do_room_banner,
541                         int unset_cookies,
542                         int suppress_check,
543                         int cache);
544 void wprintf(const char *format,...)__attribute__((__format__(__printf__,1,2)));
545 void hprintf(const char *format,...)__attribute__((__format__(__printf__,1,2)));
546 void output_static(char *what);
547 void display_mime_icon(void);
548 void print_menu_box(char* Title, char *Class, int nLines, ...);
549 long stresc(char *target, long tSize, char *strbuf, int nbsp, int nolinebreaks);
550 void escputs(char *strbuf);
551 void url(char *buf, size_t bufsize);
552 void escputs1(char *strbuf, int nbsp, int nolinebreaks);
553 void msgesc(char *target, size_t tlen, char *strbuf);
554 void msgescputs(char *strbuf);
555 void msgescputs1(char *strbuf);
556 void stripout(char *str, char leftboundary, char rightboundary);
557 void dump_vars(void);
558 void embed_main_menu(void);
559 void serv_read(char *buf, int bytes);
560 void readloop(char *oper);
561 void read_message(long msgnum, int printable_view, char *section);
562 void text_to_server(char *ptr);
563 void text_to_server_qp(char *ptr);
564 void confirm_delete_msg(void);
565 void display_success(char *);
566 void authorization_required(const char *message);
567 void server_to_text(void);
568 void save_edit(char *description, char *enter_cmd, int regoto);
569 void display_edit(char *description, char *check_cmd,
570                   char *read_cmd, char *save_cmd, int with_room_banner);
571 int gotoroom(char *gname);
572 void confirm_delete_room(void);
573 void validate(void);
574 void display_graphics_upload(char *, char *, char *);
575 void do_graphics_upload(char *upl_cmd);
576 void serv_read(char *buf, int bytes);
577 void serv_gets(char *strbuf);
578 void serv_write(char *buf, int nbytes);
579 void serv_puts(char *string);
580 void serv_printf(const char *format,...)__attribute__((__format__(__printf__,1,2)));
581 void load_floorlist(void);
582 void shutdown_sessions(void);
583 void do_housekeeping(void);
584 void smart_goto(char *);
585 void worker_entry(void);
586 void session_loop(struct httprequest *);
587 size_t wc_strftime(char *s, size_t max, const char *format, const struct tm *tm);
588 void fmt_time(char *buf, time_t thetime);
589 void httpdate(char *buf, time_t thetime);
590 time_t httpdate_to_timestamp(char *buf);
591 void end_webcit_session(void);
592 void page_popup(void);
593 void http_redirect(const char *);
594 void clear_substs(struct wcsession *wc);
595 void clear_local_substs(void);
596
597
598 typedef void (*var_callback_fptr)();
599
600
601 void SVPut(char *keyname, size_t keylen, int keytype, char *Data);
602 #define svput(a, b, c) SVPut(a, sizeof(a) - 1, b, c)
603 void svprintf(char *keyname, size_t keylen, int keytype, const char *format,...) __attribute__((__format__(__printf__,4,5)));
604 void SVPRINTF(char *keyname, int keytype, const char *format,...) __attribute__((__format__(__printf__,3,4)));
605 void SVCALLBACK(char *keyname, var_callback_fptr fcn_ptr);
606 void SVCallback(char *keyname, size_t keylen,  var_callback_fptr fcn_ptr);
607 #define svcallback(a, b) SVCallback(a, sizeof(a) - 1, b)
608
609 void do_template(void *templatename);
610
611
612 int lingering_close(int fd);
613 char *memreadline(char *start, char *buf, int maxlen);
614 char *memreadlinelen(char *start, char *buf, int maxlen, int *retlen);
615 long extract_token(char *dest, const char *source, int parmnum, char separator, int maxlen);
616 void remove_token(char *source, int parmnum, char separator);
617 char *load_mimepart(long msgnum, char *partnum);
618 int pattern2(char *search, char *patn);
619 void do_edit_vcard(long, char *, char *, char *);
620 void striplt(char *);
621 void stripltlen(char *, int *);
622 void select_user_to_edit(char *message, char *preselect);
623 void delete_user(char *);
624 void do_change_view(int);
625 void folders(void);
626
627
628 void load_preferences(void);
629 void save_preferences(void);
630 #define get_preference(a, b) get_PREFERENCE(a, sizeof(a) - 1, b)
631 #define get_pref(a, b)       get_PREFERENCE(ChrPtr(a), StrLength(a), b)
632 int get_PREFERENCE(const char *key, size_t keylen, StrBuf **value);
633 #define set_preference(a, b, c) set_PREFERENCE(a, sizeof(a) - 1, b, c)
634 #define set_pref(a, b, c)       set_PREFERENCE(ChrPtr(a), StrLength(a), b, c)
635 void set_PREFERENCE(const char *key, size_t keylen, StrBuf *value, int save_to_server);
636
637 #define get_pref_long(a, b, c) get_PREF_LONG(a, sizeof(a) - 1, b, c)
638 int get_PREF_LONG(const char *key, size_t keylen, long *value, long Default);
639 #define set_pref_long(a, b, c) set_PREF_LONG(a, sizeof(a) - 1, b, c)
640 void set_PREF_LONG(const char *key, size_t keylen, long value, int save_to_server);
641
642 #define get_pref_yesno(a, b, c) get_PREF_YESNO(a, sizeof(a) - 1, b, c)
643 int get_PREF_YESNO(const char *key, size_t keylen, int *value, int Default);
644 #define set_pref_yesno(a, b, c) set_PREF_YESNO(a, sizeof(a) - 1, b, c)
645 void set_PREF_YESNO(const char *key, size_t keylen, int value, int save_to_server);
646
647
648
649 int is_msg_in_mset(char *mset, long msgnum);
650 void display_addressbook(long msgnum, char alpha);
651 void offer_start_page(void);
652 void convenience_page(char *titlebarcolor, char *titlebarmsg, char *messagetext);
653 void output_html(char *, int);
654 void do_listsub(void);
655 void toggle_self_service(void);
656 ssize_t write(int fd, const void *buf, size_t count);
657 void cal_process_attachment(char *part_source, long msgnum, char *cal_partnum);
658 void display_calendar(long msgnum, int unread);
659 void display_task(long msgnum, int unread);
660 void display_note(long msgnum, int unread);
661 void updatenote(void);
662 void do_calendar_view(void);
663 void do_tasks_view(void);
664 void calendar_summary_view(void);
665 int load_msg_ptrs(char *servcmd, int with_headers);
666 void free_attachments(struct wcsession *sess);
667 void free_march_list(struct wcsession *wcf);
668 void display_rules_editor_inner_div(void);
669 void generate_uuid(char *);
670 void CtdlMakeTempFileName(char *, int);
671 void address_book_popup(void);
672 void begin_ajax_response(void);
673 void end_ajax_response(void);
674 void initialize_viewdefs(void);
675 void initialize_axdefs(void);
676 void burn_folder_cache(time_t age);
677 void list_all_rooms_by_floor(const char *viewpref);
678 void display_pictureview(void);
679
680 void display_edit_task(void);
681 void display_edit_event(void);
682 icaltimezone *get_default_icaltimezone(void);
683 void display_icaltimetype_as_webform(struct icaltimetype *, char *);
684 void icaltime_from_webform(struct icaltimetype *result, char *prefix);
685 void icaltime_from_webform_dateonly(struct icaltimetype *result, char *prefix);
686 void display_edit_individual_event(icalcomponent *supplied_vtodo, long msgnum, char *from, int unread);
687 void save_individual_event(icalcomponent *supplied_vtodo, long msgnum, char *from, int unread);
688 void ical_dezonify(icalcomponent *cal);
689 void partstat_as_string(char *buf, icalproperty *attendee);
690 icalcomponent *ical_encapsulate_subcomponent(icalcomponent *subcomp);
691 void check_attendee_availability(icalcomponent *supplied_vevent);
692 void do_freebusy(char *req);
693 int ical_ctdl_is_overlap(
694                         struct icaltimetype t1start,
695                         struct icaltimetype t1end,
696                         struct icaltimetype t2start,
697                         struct icaltimetype t2end
698 );
699
700 #ifdef ENABLE_NLS
701 void initialize_locales(void);
702 #endif
703
704 extern char *months[];
705 extern char *days[];
706 StrBuf *read_server_binary(size_t total_len);
707 int StrBuf_ServGetBLOB(StrBuf *buf, long BlobSize);
708 StrBuf *read_server_text(long *nLines);
709 int goto_config_room(void);
710 long locate_user_vcard(char *username, long usernum);
711 void sleeeeeeeeeep(int);
712 void http_transmit_thing(StrBuf *thing, const char *content_type, int is_static);
713 long unescape_input(char *buf);
714 void do_selected_iconbar(void);
715 int CtdlDecodeQuotedPrintable(char *decoded, char *encoded, int sourcelen);
716 void spawn_another_worker_thread(void);
717 void display_rss(char *roomname, char *request_method);
718 void offer_languages(void);
719 void set_selected_language(char *);
720 void go_selected_language(void);
721 void stop_selected_language(void);
722 void preset_locale(void);
723 void httplang_to_locale(char *LocaleString);
724 void tabbed_dialog(int num_tabs, char *tabnames[]);
725 void begin_tab(int tabnum, int num_tabs);
726 void end_tab(int tabnum, int num_tabs);
727 void str_wiki_index(char *s);
728 int get_time_format_cached (void);
729 int xtoi(char *in, size_t len);
730 void webcit_fmt_date(char *buf, time_t thetime, int brief);
731 int fetch_http(char *url, char *target_buf, int maxbytes);
732
733 int is_mobile_ua(char *user_agent);
734
735 #ifdef HAVE_ICONV
736 iconv_t ctdl_iconv_open(const char *tocode, const char *fromcode);
737 #endif
738
739 void embed_room_banner(char *, int);
740
741 /* navbar types that can be passed to embed_room_banner */
742 enum {
743         navbar_none,
744         navbar_default
745 };
746
747
748 #ifdef HAVE_OPENSSL
749 void init_ssl(void);
750 void endtls(void);
751 void ssl_lock(int mode, int n, const char *file, int line);
752 int starttls(int sock);
753 extern SSL_CTX *ssl_ctx;  
754 int client_read_ssl(char *buf, int bytes, int timeout);
755 void client_write_ssl(const char *buf, int nbytes);
756 #endif
757
758 #ifdef HAVE_ZLIB
759 #include <zlib.h>
760 int ZEXPORT compress_gzip(Bytef * dest, size_t * destLen,
761                           const Bytef * source, uLong sourceLen, int level);
762 #endif
763
764 void utf8ify_rfc822_string(char *buf);
765
766 void begin_burst(void);
767 long end_burst(void);
768
769 extern char *hourname[];        /**< Names of hours (12am, 1am, etc.) */
770
771 void http_datestring(char *buf, size_t n, time_t xtime);
772
773
774 typedef void (*WebcitHandlerFunc)(void);
775 typedef struct  _WebcitHandler{
776         WebcitHandlerFunc F;
777         long Flags;
778 } WebcitHandler;
779 void WebcitAddUrlHandler(const char * UrlString, long UrlSLen, WebcitHandlerFunc F, long Flags);
780
781 #define AJAX (1<<0)
782 #define ANONYMOUS (1<<1)
783 #define NEED_URL (1<<2)
784
785
786 /* These should be empty, but we have them for testing */
787 #define DEFAULT_HTTPAUTH_USER   ""
788 #define DEFAULT_HTTPAUTH_PASS   ""
789
790
791 /* Exit codes 101 through 109 are initialization failures so we don't want to
792  * just keep respawning indefinitely.
793  */
794 #define WC_EXIT_BIND            101     /* Can't bind to the port */
795 #define WC_EXIT_SSL             102     /* Can't initialize SSL */
796
797
798 #define WC_TIMEFORMAT_NONE 0
799 #define WC_TIMEFORMAT_AMPM 1
800 #define WC_TIMEFORMAT_24 2
801
802