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