]> code.citadel.org Git - citadel.git/blob - webcit/webcit.h
* The iconbar roomlist, when selected, is now persistent across page loads
[citadel.git] / webcit / webcit.h
1 /* $Id$ */
2
3 #include <ctype.h>
4 #include <stdlib.h>
5 #ifdef HAVE_UNISTD_H
6 #include <unistd.h>
7 #endif
8 #include <stdio.h>
9 #ifdef HAVE_FCNTL_H
10 #include <fcntl.h>
11 #endif
12 #include <signal.h>
13 #include <sys/types.h>
14 #include <sys/wait.h>
15 #include <sys/socket.h>
16 #ifdef HAVE_SYS_TIME_H
17 #include <sys/time.h>
18 #endif
19 #include <sys/stat.h>
20 #ifdef HAVE_LIMITS_H
21 #include <limits.h>
22 #endif
23 #include <netinet/in.h>
24 #include <arpa/inet.h>
25 #include <sys/un.h>
26 #include <netdb.h>
27 #include <sys/poll.h>
28 #include <string.h>
29 #include <pwd.h>
30 #include <errno.h>
31 #include <stdarg.h>
32 #include <pthread.h>
33 #include <signal.h>
34 #include <sys/utsname.h>
35
36 #ifndef INADDR_NONE
37 #define INADDR_NONE 0xffffffff
38 #endif
39
40 #ifdef HAVE_ICONV
41 #include <iconv.h>
42 #endif
43
44 #include "gettext.h"
45
46 #if ENABLE_NLS
47 #include <locale.h>
48 #define _(string)       gettext(string)
49 #else
50 #define _(string)       (string)
51 #endif
52
53 /*
54  * Uncomment to dump an HTTP trace to stderr
55 #define HTTP_TRACING 1
56  */
57
58 #ifdef HTTP_TRACING
59 #undef HAVE_ZLIB_H
60 #undef HAVE_ZLIB
61 #endif
62
63 #ifdef HAVE_ZLIB_H
64 #include <zlib.h>
65 #endif
66
67 #ifdef HAVE_ICAL_H
68 #ifdef HAVE_LIBICAL
69 #define WEBCIT_WITH_CALENDAR_SERVICE 1
70 #endif
71 #endif
72
73 #ifdef WEBCIT_WITH_CALENDAR_SERVICE
74 #include <ical.h>
75 #endif
76
77 #ifdef HAVE_OPENSSL
78 /* Work around RedHat's b0rken OpenSSL includes */
79 #define OPENSSL_NO_KRB5
80 #include <openssl/ssl.h>
81 #include <openssl/err.h>
82 #include <openssl/rand.h>
83 #endif
84
85 #define CALENDAR_ROOM_NAME      "Calendar"
86 #define PRODID "-//Citadel//NONSGML Citadel Calendar//EN"
87
88 #define SIZ                     4096            /* generic buffer size */
89
90 #define TRACE fprintf(stderr, "Checkpoint: %s, %d\n", __FILE__, __LINE__)
91
92 #define SLEEPING                180             /* TCP connection timeout */
93 #define WEBCIT_TIMEOUT          900             /* WebCit session timeout */
94 #define PORT_NUM                2000            /* port number to listen on */
95 #define SERVER                  "WebCit v6.40"  /* who's in da house */
96 #define DEVELOPER_ID            0
97 #define CLIENT_ID               4
98 #define CLIENT_VERSION          640             /* This version of WebCit */
99 #define MINIMUM_CIT_VERSION     661             /* min required Citadel ver. */
100 #define DEFAULT_HOST            "localhost"     /* Default Citadel server */
101 #define DEFAULT_PORT            "504"
102 #define LB                      (1)             /* Internal escape chars */
103 #define RB                      (2)
104 #define QU                      (3)
105 #define TARGET                  "webcit01"      /* Target for inline URL's */
106 #define HOUSEKEEPING            15              /* Housekeeping frequency */
107 #define MIN_WORKER_THREADS      5
108 #define MAX_WORKER_THREADS      250
109 #define LISTEN_QUEUE_LENGTH     100             /* listen() backlog queue */
110
111 #define USERCONFIGROOM          "My Citadel Config"
112 #define DEFAULT_MAXMSGS         20
113
114
115 /*
116  * Room flags (from Citadel)
117  *
118  * bucket one...
119  */
120 #define QR_PERMANENT    1               /* Room does not purge        */
121 #define QR_INUSE        2               /* Set if in use, clear if avail    */
122 #define QR_PRIVATE      4               /* Set for any type of private room */
123 #define QR_PASSWORDED   8               /* Set if there's a password too    */
124 #define QR_GUESSNAME    16              /* Set if it's a guessname room     */
125 #define QR_DIRECTORY    32              /* Directory room                  */
126 #define QR_UPLOAD       64              /* Allowed to upload            */
127 #define QR_DOWNLOAD     128             /* Allowed to download        */
128 #define QR_VISDIR       256             /* Visible directory            */
129 #define QR_ANONONLY     512             /* Anonymous-Only room        */
130 #define QR_ANONOPT      1024            /* Anonymous-Option room            */
131 #define QR_NETWORK      2048            /* Shared network room        */
132 #define QR_PREFONLY     4096            /* Preferred status needed to enter */
133 #define QR_READONLY     8192            /* Aide status required to post     */
134 #define QR_MAILBOX      16384           /* Set if this is a private mailbox */
135
136 /*
137  * bucket two...
138  */
139 #define QR2_SYSTEM      1               /* System room; hide by default     */
140 #define QR2_SELFLIST    2               /* Self-service mailing list mgmt   */
141
142
143 #define UA_KNOWN                2
144 #define UA_GOTOALLOWED    4
145 #define UA_HASNEWMSGS      8
146 #define UA_ZAPPED              16
147
148
149 /*
150  * User flags (from Citadel)
151  */
152 #define US_NEEDVALID    1               /* User needs to be validated       */
153 #define US_PERM         4               /* Permanent user                   */
154 #define US_LASTOLD      16              /* Print last old message with new  */
155 #define US_EXPERT       32              /* Experienced user                 */
156 #define US_UNLISTED     64              /* Unlisted userlog entry           */
157 #define US_NOPROMPT     128             /* Don't prompt after each message  */
158 #define US_PROMPTCTL    256             /* <N>ext & <S>top work at prompt   */
159 #define US_DISAPPEAR    512             /* Use "disappearing msg prompts"   */
160 #define US_REGIS        1024            /* Registered user                  */
161 #define US_PAGINATOR    2048            /* Pause after each screen of text  */
162 #define US_INTERNET     4096            /* Internet mail privileges         */
163 #define US_FLOORS       8192            /* User wants to see floors         */
164 #define US_COLOR        16384           /* User wants ANSI color support    */
165 #define US_USER_SET     (US_LASTOLD | US_EXPERT | US_UNLISTED | \
166                         US_NOPROMPT | US_DISAPPEAR | US_PAGINATOR | \
167                         US_FLOORS | US_COLOR | US_PROMPTCTL )
168
169
170
171
172 struct httprequest {
173         struct httprequest *next;
174         char line[SIZ];
175 };
176
177 struct urlcontent {
178         struct urlcontent *next;
179         char url_key[32];
180         char *url_data;
181 };
182
183 struct serv_info {
184         int serv_pid;
185         char serv_nodename[32];
186         char serv_humannode[64];
187         char serv_fqdn[64];
188         char serv_software[64];
189         int serv_rev_level;
190         char serv_bbs_city[64];
191         char serv_sysadm[64];
192         char serv_moreprompt[SIZ];
193         int serv_ok_floors;
194         int serv_supports_ldap;
195 };
196
197
198
199 /*
200  * This struct holds a list of rooms for <G>oto operations.
201  */
202 struct march {
203         struct march *next;
204         char march_name[128];
205         int march_floor;
206         int march_order;
207 };
208
209 /* 
210  * This struct holds a list of rooms for client display.
211  * (oooh, a tree!)
212  */
213 struct roomlisting {
214         struct roomlisting *lnext;
215         struct roomlisting *rnext;
216         char rlname[128];
217         unsigned rlflags;
218         int rlfloor;
219         int rlorder;
220 };
221
222
223
224 /*
225  * Dynamic content for variable substitution in templates
226  */
227 struct wcsubst {
228         struct wcsubst *next;
229         int wcs_type;
230         char wcs_key[32];
231         void *wcs_value;
232         void (*wcs_function)(void);
233 };
234
235 /*
236  * Values for wcs_type
237  */
238 enum {
239         WCS_STRING,
240         WCS_FUNCTION,
241         WCS_SERVCMD
242 };
243
244
245 struct wc_attachment {
246         struct wc_attachment *next;
247         size_t length;
248         char content_type[SIZ];
249         char filename[SIZ];
250         char *data;
251 };
252
253 struct message_summary {
254         time_t date;
255         long msgnum;
256         char from[128];
257         char to[128];
258         char subj[128];
259         int hasattachments;
260         int is_new;
261 };
262
263 /* Data structure for roomlist-to-folderlist conversion */
264 struct folder {
265         int floor;
266         char room[SIZ];
267         char name[SIZ];
268         int hasnewmsgs;
269         int is_mailbox;
270         int selectable;
271         int view;
272 };
273
274 /*
275  * One of these is kept for each active Citadel session.
276  * HTTP transactions are bound to one at a time.
277  */
278 struct wcsession {
279         struct wcsession *next;         /* Linked list */
280         int wc_session;                 /* WebCit session ID */
281         char wc_username[128];
282         char wc_password[128];
283         char wc_roomname[256];
284         int connected;
285         int logged_in;
286         int axlevel;
287         int is_aide;
288         int is_room_aide;
289         int http_sock;
290         int serv_sock;
291         int chat_sock;
292         unsigned room_flags;
293         int wc_view;
294         int wc_default_view;
295         int wc_floor;
296         char ugname[128];
297         long uglsn;
298         int upload_length;
299         char *upload;
300         char upload_filename[PATH_MAX];
301         char upload_content_type[256];
302         int new_mail;
303         int remember_new_mail;
304         int need_regi;                  /* This user needs to register. */
305         int need_vali;                  /* New users require validation. */
306         char cs_inet_email[256];        /* User's preferred Internet addr. */
307         pthread_mutex_t SessionMutex;   /* mutex for exclusive access */
308         time_t lastreq;                 /* Timestamp of most recent HTTP */
309         int killthis;                   /* Nonzero == purge this session */
310         struct march *march;            /* march mode room list */
311         char reply_to[512];             /* reply-to address */
312
313         long msgarr[10000];             /* for read operations */
314         int num_summ;
315         struct message_summary *summ;
316
317         int is_wap;                     /* Client is a WAP gateway */
318         struct urlcontent *urlstrings;
319         int HaveInstantMessages;        /* Nonzero if incoming msgs exist */
320         struct wcsubst *vars;
321         char this_page[512];            /* address of current page */
322         char http_host[512];            /* HTTP Host: header */
323         char *preferences;
324 #ifdef WEBCIT_WITH_CALENDAR_SERVICE
325         struct disp_cal {
326                 icalcomponent *cal;             /* cal items for display */
327                 long cal_msgnum;                /* cal msgids for display */
328         } *disp_cal;
329         int num_cal;
330 #endif
331         struct wc_attachment *first_attachment;
332         char ImportantMessage[SIZ];
333         char last_chat_user[256];
334         int ctdl_pid;                   /* Session ID on the Citadel server */
335         char httpauth_user[256];        /* only for GroupDAV sessions */
336         char httpauth_pass[256];        /* only for GroupDAV sessions */
337
338         size_t burst_len;
339         char *burst;
340         int gzip_ok;                    /* Nonzero if Accept-encoding: gzip */
341         int is_mailbox;                 /* the current room is a private mailbox */
342
343         struct folder *cache_fold;      /* cache the iconbar room list */
344         int cache_max_folders;
345         int cache_num_floors;
346         time_t cache_timestamp;
347
348         int current_iconbar;            /* What's currently in the iconbar? */
349 };
350
351 /* values for WC->current_iconbar */
352 enum {
353         current_iconbar_menu,
354         current_iconbar_roomlist
355 };
356
357
358 #define num_parms(source)               num_tokens(source, '|')
359
360 /* Per-session data */
361 #define WC ((struct wcsession *)pthread_getspecific(MyConKey))
362 extern pthread_key_t MyConKey;
363
364 /* Per-thread SSL context */
365 #ifdef HAVE_OPENSSL
366 #define THREADSSL ((SSL *)pthread_getspecific(ThreadSSL))
367 extern pthread_key_t ThreadSSL;
368 #endif
369
370 struct serv_info serv_info;
371 extern char floorlist[128][SIZ];
372 extern char *axdefs[];
373 extern char *ctdlhost, *ctdlport;
374 extern char *server_cookie;
375 extern int is_https;
376 extern int setup_wizard;
377 extern char wizard_filename[];
378 extern time_t if_modified_since;
379 extern int follow_xff;
380 void do_setup_wizard(void);
381
382 void stuff_to_cookie(char *cookie, int session,
383                         char *user, char *pass, char *room);
384 void cookie_to_stuff(char *cookie, int *session,
385                 char *user, size_t user_len,
386                 char *pass, size_t pass_len,
387                 char *room, size_t room_len);
388 void locate_host(char *, int);
389 void become_logged_in(char *, char *, char *);
390 void do_login(void);
391 void display_login(char *mesg);
392 void do_welcome(void);
393 void do_logout(void);
394 void display_main_menu(void);
395 void display_aide_menu(void);
396 void display_advanced_menu(void);
397 void slrp_highest(void);
398 void gotonext(void);
399 void ungoto(void);
400 void get_serv_info(char *, char *);
401 int uds_connectsock(char *);
402 int tcp_connectsock(char *, char *);
403 void serv_getln(char *strbuf, int bufsize);
404 void serv_puts(char *string);
405 void who(void);
406 void who_inner_div(void);
407 void fmout(char *align);
408 void pullquote_fmout(void);
409 void wDumpContent(int);
410 void serv_printf(const char *format,...);
411 char *bstr(char *key);
412 void urlesc(char *, char *);
413 void urlescputs(char *);
414 void jsesc(char *, char *);
415 void jsescputs(char *);
416 void output_headers(    int do_httpheaders,
417                         int do_htmlhead,
418                         int do_room_banner,
419                         int unset_cookies,
420                         int suppress_check,
421                         int cache);
422 void wprintf(const char *format,...);
423 void output_static(char *what);
424 void stresc(char *target, char *strbuf, int nbsp, int nolinebreaks);
425 void escputs(char *strbuf);
426 void url(char *buf);
427 void escputs1(char *strbuf, int nbsp, int nolinebreaks);
428 void msgesc(char *target, char *strbuf);
429 void msgescputs(char *strbuf);
430 int extract_int(const char *source, int parmnum);
431 long extract_long(const char *source, int parmnum);
432 void stripout(char *str, char leftboundary, char rightboundary);
433 void dump_vars(void);
434 void embed_main_menu(void);
435 void serv_read(char *buf, int bytes);
436 int haschar(char *, char);
437 void readloop(char *oper);
438 void embed_message(char *msgnum_as_string);
439 void print_message(char *msgnum_as_string);
440 void text_to_server(char *ptr, int convert_to_html);
441 void display_enter(void);
442 void post_message(void);
443 void confirm_delete_msg(void);
444 void delete_msg(void);
445 void confirm_move_msg(void);
446 void move_msg(void);
447 void userlist(void);
448 void showuser(void);
449 void display_page(void);
450 void page_user(void);
451 void do_chat(void);
452 void display_private(char *rname, int req_pass);
453 void goto_private(void);
454 void zapped_list(void);
455 void display_zap(void);
456 void zap(void);
457 void display_success(char *);
458 void authorization_required(const char *message);
459 void display_entroom(void);
460 void entroom(void);
461 void display_editroom(void);
462 void netedit(void);
463 void editroom(void);
464 void display_whok(void);
465 void do_invt_kick(void);
466 void server_to_text(void);
467 void save_edit(char *description, char *enter_cmd, int regoto);
468 void display_edit(char *description, char *check_cmd,
469                   char *read_cmd, char *save_cmd, int with_room_banner);
470 int gotoroom(char *gname);
471 void confirm_delete_room(void);
472 void delete_room(void);
473 void validate(void);
474 void display_graphics_upload(char *, char *, char *);
475 void do_graphics_upload(char *upl_cmd);
476 void serv_read(char *buf, int bytes);
477 void serv_gets(char *strbuf);
478 void serv_write(char *buf, int nbytes);
479 void serv_puts(char *string);
480 void serv_printf(const char *format,...);
481 void load_floorlist(void);
482 void display_reg(int);
483 void display_changepw(void);
484 void changepw(void);
485 void display_edit_node(void);
486 void edit_node(void);
487 void display_netconf(void);
488 void display_confirm_delete_node(void);
489 void delete_node(void);
490 void display_add_node(void);
491 void add_node(void);
492 void terminate_session(void);
493 void edit_me(void);
494 void display_siteconfig(void);
495 void siteconfig(void);
496 void display_generic(void);
497 void do_generic(void);
498 void ajax_servcmd(void);
499 void display_menubar(int);
500 void smart_goto(char *);
501 void worker_entry(void);
502 void session_loop(struct httprequest *);
503 void fmt_date(char *buf, time_t thetime, int brief);
504 void fmt_time(char *buf, time_t thetime);
505 void httpdate(char *buf, time_t thetime);
506 time_t httpdate_to_timestamp(const char *buf);
507 void end_webcit_session(void);
508 void page_popup(void);
509 void chat_recv(void);
510 void chat_send(void);
511 void http_redirect(char *);
512 void clear_local_substs(void);
513 void svprintf(char *keyname, int keytype, const char *format,...);
514 void svcallback(char *keyname, void (*fcn_ptr)() );
515 void do_template(void *templatename);
516 int lingering_close(int fd);
517 char *memreadline(char *start, char *buf, int maxlen);
518 int num_tokens (char *source, char tok);
519 void extract_token(char *dest, const char *source, int parmnum, char separator, int maxlen);
520 void remove_token(char *source, int parmnum, char separator);
521 char *load_mimepart(long msgnum, char *partnum);
522 int pattern2(char *search, char *patn);
523 void do_edit_vcard(long, char *, char *);
524 void edit_vcard(void);
525 void submit_vcard(void);
526 void striplt(char *);
527 void select_user_to_edit(char *message, char *preselect);
528 void delete_user(char *);
529 void display_edituser(char *who, int is_new);
530 void create_user(void);
531 void edituser(void);
532 void do_change_view(int);
533 void change_view(void);
534 void folders(void);
535 void load_preferences(void);
536 void save_preferences(void);
537 void get_preference(char *key, char *value, size_t value_len);
538 void set_preference(char *key, char *value, int save_to_server);
539 void knrooms(void);
540 int is_msg_in_mset(char *mset, long msgnum);
541 char *safestrncpy(char *dest, const char *src, size_t n);
542 void display_addressbook(long msgnum, char alpha);
543 void offer_start_page(void);
544 void convenience_page(char *titlebarcolor, char *titlebarmsg, char *messagetext);
545 void change_start_page(void);
546 void output_html(char *);
547 void display_floorconfig(char *);
548 void delete_floor(void);
549 void create_floor(void);
550 void rename_floor(void);
551 void do_listsub(void);
552 void toggle_self_service(void);
553 void summary(void);
554 void summary_inner_div(void);
555 ssize_t write(int fd, const void *buf, size_t count);
556 void cal_process_attachment(char *part_source, long msgnum, char *cal_partnum);
557 void display_calendar(long msgnum);
558 void display_task(long msgnum);
559 void display_note(long msgnum);
560 void do_calendar_view(void);
561 void do_tasks_view(void);
562 void free_calendar_buffer(void);
563 void calendar_summary_view(void);
564 int load_msg_ptrs(char *servcmd, int with_headers);
565 void CtdlEncodeBase64(char *dest, const char *source, size_t sourcelen);
566 int CtdlDecodeBase64(char *dest, const char *source, size_t length);
567 void free_attachments(struct wcsession *sess);
568 void set_room_policy(void);
569 void display_inetconf(void);
570 void save_inetconf(void);
571 void generate_uuid(char *);
572 void CtdlMakeTempFileName(char *, int);
573 void display_preferences(void);
574 void set_preferences(void);
575 void recp_autocomplete(char *);
576 void begin_ajax_response(void);
577 void end_ajax_response(void);
578 void initialize_viewdefs(void);
579 void initialize_axdefs(void);
580 void list_all_rooms_by_floor(char *viewpref);
581
582 #ifdef WEBCIT_WITH_CALENDAR_SERVICE
583 void display_edit_task(void);
584 void save_task(void);
585 void display_edit_event(void);
586 void save_event(void);
587 void display_icaltimetype_as_webform(struct icaltimetype *, char *);
588 void icaltime_from_webform(struct icaltimetype *result, char *prefix);
589 void icaltime_from_webform_dateonly(struct icaltimetype *result, char *prefix);
590 void display_edit_individual_event(icalcomponent *supplied_vtodo, long msgnum);
591 void save_individual_event(icalcomponent *supplied_vtodo, long msgnum);
592 void respond_to_request(void);
593 void handle_rsvp(void);
594 void ical_dezonify(icalcomponent *cal);
595 void partstat_as_string(char *buf, icalproperty *attendee);
596 icalcomponent *ical_encapsulate_subcomponent(icalcomponent *subcomp);
597 void check_attendee_availability(icalcomponent *supplied_vevent);
598 void do_freebusy(char *req);
599 #endif
600
601 extern char *months[];
602 extern char *days[];
603 void read_server_binary(char *buffer, size_t total_len);
604 char *read_server_text(void);
605 int goto_config_room(void);
606 long locate_user_vcard(char *username, long usernum);
607 void sleeeeeeeeeep(int);
608 void http_transmit_thing(char *thing, size_t length, char *content_type,
609                          int is_static);
610 void unescape_input(char *buf);
611 void do_iconbar(void);
612 void do_iconbar_roomlist(void);
613 void do_selected_iconbar(void);
614 void display_customize_iconbar(void);
615 void commit_iconbar(void);
616 int CtdlDecodeQuotedPrintable(char *decoded, char *encoded, int sourcelen);
617 void spawn_another_worker_thread(void);
618 void display_rss(char *roomname, char *request_method);
619
620 void embed_room_banner(char *, int);
621 /* navbar types that can be passed to embed_room_banner */
622 enum {
623         navbar_none,
624         navbar_default
625 };
626
627
628 #ifdef HAVE_OPENSSL
629 void init_ssl(void);
630 void endtls(void);
631 void ssl_lock(int mode, int n, const char *file, int line);
632 int starttls(int sock);
633 extern SSL_CTX *ssl_ctx;  
634 int client_read_ssl(char *buf, int bytes, int timeout);
635 void client_write_ssl(char *buf, int nbytes);
636 #endif
637
638 #ifdef HAVE_ZLIB
639 #include <zlib.h>
640 int ZEXPORT compress_gzip(Bytef * dest, uLongf * destLen,
641                           const Bytef * source, uLong sourceLen, int level);
642 #endif
643
644 #ifdef HAVE_ICONV
645 void utf8ify_rfc822_string(char *buf);
646 #endif
647
648 void begin_burst(void);
649 void end_burst(void);
650
651 extern char *ascmonths[];
652 extern char *hourname[];
653 void http_datestring(char *buf, size_t n, time_t xtime);
654
655 /* Views (from citadel.h) */
656 #define VIEW_BBS                0       /* Traditional Citadel BBS view */
657 #define VIEW_MAILBOX            1       /* Mailbox summary */
658 #define VIEW_ADDRESSBOOK        2       /* Address book view */
659 #define VIEW_CALENDAR           3       /* Calendar view */
660 #define VIEW_TASKS              4       /* Tasks view */
661 #define VIEW_NOTES              5       /* Notes view */
662
663
664 /* These should be empty, but we have them for testing */
665 #define DEFAULT_HTTPAUTH_USER   ""
666 #define DEFAULT_HTTPAUTH_PASS   ""
667