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 /*
 264  * One of these is kept for each active Citadel session.
 265  * HTTP transactions are bound to one at a time.
 266  */
 267 struct wcsession {
 268         struct wcsession *next;         /* Linked list */
 269         int wc_session;                 /* WebCit session ID */
 270         char wc_username[SIZ];
 271         char wc_password[SIZ];
 272         char wc_roomname[SIZ];
 273         int connected;
 274         int logged_in;
 275         int axlevel;
 276         int is_aide;
 277         int is_room_aide;
 278         int http_sock;
 279         int serv_sock;
 280         int chat_sock;
 281         unsigned room_flags;
 282         int wc_view;
 283         int wc_default_view;
 284         int wc_floor;
 285         char ugname[128];
 286         long uglsn;
 287         int upload_length;
 288         char *upload;
 289         char upload_filename[SIZ];
 290         char upload_content_type[SIZ];
 291         int new_mail;
 292         int remember_new_mail;
 293         int need_regi;                  /* This user needs to register. */
 294         int need_vali;                  /* New users require validation. */
 295         char cs_inet_email[SIZ];        /* User's preferred Internet addr. */
 296         pthread_mutex_t SessionMutex;   /* mutex for exclusive access */
 297         time_t lastreq;                 /* Timestamp of most recent HTTP */
 298         int killthis;                   /* Nonzero == purge this session */
 299         struct march *march;            /* march mode room list */
 300         char reply_to[SIZ];             /* reply-to address */
 301
 302         long msgarr[10000];             /* for read operations */
 303         int num_summ;
 304         struct message_summary *summ;
 305
 306         int is_wap;                     /* Client is a WAP gateway */
 307         struct urlcontent *urlstrings;
 308         int HaveInstantMessages;        /* Nonzero if incoming msgs exist */
 309         struct wcsubst *vars;
 310         char this_page[SIZ];            /* address of current page */
 311         char http_host[SIZ];            /* HTTP Host: header */
 312         char *preferences;
 313 #ifdef WEBCIT_WITH_CALENDAR_SERVICE
 314         struct disp_cal {
 315                 icalcomponent *cal;             /* cal items for display */
 316                 long cal_msgnum;                /* cal msgids for display */
 317         } *disp_cal;
 318         int num_cal;
 319 #endif
 320         struct wc_attachment *first_attachment;
 321         char ImportantMessage[SIZ];
 322         char last_chat_user[SIZ];
 323         int ctdl_pid;                   /* Session ID on the Citadel server */
 324         char httpauth_user[SIZ];        /* only for GroupDAV sessions */
 325         char httpauth_pass[SIZ];        /* only for GroupDAV sessions */
 326
 327         size_t burst_len;
 328         char *burst;
 329         int gzip_ok;                    /* Nonzero if Accept-encoding: gzip */
 330         int is_mailbox;                 /* the current room is a private mailbox */
 331 };
 332
 333 #define num_parms(source)               num_tokens(source, '|')
 334
 335 /* Per-session data */
 336 #define WC ((struct wcsession *)pthread_getspecific(MyConKey))
 337 extern pthread_key_t MyConKey;
 338
 339 /* Per-thread SSL context */
 340 #ifdef HAVE_OPENSSL
 341 #define THREADSSL ((SSL *)pthread_getspecific(ThreadSSL))
 342 extern pthread_key_t ThreadSSL;
 343 #endif
 344
 345 struct serv_info serv_info;
 346 extern char floorlist[128][SIZ];
 347 extern char *axdefs[];
 348 extern char *ctdlhost, *ctdlport;
 349 extern char *server_cookie;
 350 extern int is_https;
 351 extern int setup_wizard;
 352 extern char wizard_filename[];
 353 extern time_t if_modified_since;
 354 extern int follow_xff;
 355 void do_setup_wizard(void);
 356
 357 void stuff_to_cookie(char *cookie, int session,
 358                         char *user, char *pass, char *room);
 359 void cookie_to_stuff(char *cookie, int *session,
 360                 char *user, size_t user_len,
 361                 char *pass, size_t pass_len,
 362                 char *room, size_t room_len);
 363 void locate_host(char *, int);
 364 void become_logged_in(char *, char *, char *);
 365 void do_login(void);
 366 void display_login(char *mesg);
 367 void do_welcome(void);
 368 void do_logout(void);
 369 void display_main_menu(void);
 370 void display_aide_menu(void);
 371 void display_advanced_menu(void);
 372 void slrp_highest(void);
 373 void gotonext(void);
 374 void ungoto(void);
 375 void get_serv_info(char *, char *);
 376 int uds_connectsock(char *);
 377 int tcp_connectsock(char *, char *);
 378 void serv_getln(char *strbuf, int bufsize);
 379 void serv_puts(char *string);
 380 void who(void);
 381 void who_inner_div(void);
 382 void fmout(char *align);
 383 void pullquote_fmout(void);
 384 void wDumpContent(int);
 385 void serv_printf(const char *format,...);
 386 char *bstr(char *key);
 387 void urlesc(char *, char *);
 388 void urlescputs(char *);
 389 void jsesc(char *, char *);
 390 void jsescputs(char *);
 391 void output_headers(    int do_httpheaders,
 392                         int do_htmlhead,
 393                         int do_room_banner,
 394                         int unset_cookies,
 395                         int suppress_check,
 396                         int cache);
 397 void wprintf(const char *format,...);
 398 void output_static(char *what);
 399 void stresc(char *target, char *strbuf, int nbsp, int nolinebreaks);
 400 void escputs(char *strbuf);
 401 void url(char *buf);
 402 void escputs1(char *strbuf, int nbsp, int nolinebreaks);
 403 void msgesc(char *target, char *strbuf);
 404 void msgescputs(char *strbuf);
 405 int extract_int(const char *source, int parmnum);
 406 long extract_long(const char *source, int parmnum);
 407 void stripout(char *str, char leftboundary, char rightboundary);
 408 void dump_vars(void);
 409 void embed_main_menu(void);
 410 void serv_read(char *buf, int bytes);
 411 int haschar(char *, char);
 412 void readloop(char *oper);
 413 void embed_message(char *msgnum_as_string);
 414 void print_message(char *msgnum_as_string);
 415 void text_to_server(char *ptr, int convert_to_html);
 416 void display_enter(void);
 417 void post_message(void);
 418 void confirm_delete_msg(void);
 419 void delete_msg(void);
 420 void confirm_move_msg(void);
 421 void move_msg(void);
 422 void userlist(void);
 423 void showuser(void);
 424 void display_page(void);
 425 void page_user(void);
 426 void do_chat(void);
 427 void display_private(char *rname, int req_pass);
 428 void goto_private(void);
 429 void zapped_list(void);
 430 void display_zap(void);
 431 void zap(void);
 432 void display_success(char *);
 433 void authorization_required(const char *message);
 434 void display_entroom(void);
 435 void entroom(void);
 436 void display_editroom(void);
 437 void netedit(void);
 438 void editroom(void);
 439 void display_whok(void);
 440 void do_invt_kick(void);
 441 void server_to_text(void);
 442 void save_edit(char *description, char *enter_cmd, int regoto);
 443 void display_edit(char *description, char *check_cmd,
 444                   char *read_cmd, char *save_cmd, int with_room_banner);
 445 int gotoroom(char *gname);
 446 void confirm_delete_room(void);
 447 void delete_room(void);
 448 void validate(void);
 449 void display_graphics_upload(char *, char *, char *);
 450 void do_graphics_upload(char *upl_cmd);
 451 void serv_read(char *buf, int bytes);
 452 void serv_gets(char *strbuf);
 453 void serv_write(char *buf, int nbytes);
 454 void serv_puts(char *string);
 455 void serv_printf(const char *format,...);
 456 void load_floorlist(void);
 457 void display_reg(int);
 458 void display_changepw(void);
 459 void changepw(void);
 460 void display_edit_node(void);
 461 void edit_node(void);
 462 void display_netconf(void);
 463 void display_confirm_delete_node(void);
 464 void delete_node(void);
 465 void display_add_node(void);
 466 void add_node(void);
 467 void terminate_session(void);
 468 void edit_me(void);
 469 void display_siteconfig(void);
 470 void siteconfig(void);
 471 void display_generic(void);
 472 void do_generic(void);
 473 void ajax_servcmd(void);
 474 void display_menubar(int);
 475 void smart_goto(char *);
 476 void worker_entry(void);
 477 void session_loop(struct httprequest *);
 478 void fmt_date(char *buf, time_t thetime, int brief);
 479 void fmt_time(char *buf, time_t thetime);
 480 void httpdate(char *buf, time_t thetime);
 481 time_t httpdate_to_timestamp(const char *buf);
 482 void end_webcit_session(void);
 483 void page_popup(void);
 484 void chat_recv(void);
 485 void chat_send(void);
 486 void http_redirect(char *);
 487 void clear_local_substs(void);
 488 void svprintf(char *keyname, int keytype, const char *format,...);
 489 void svcallback(char *keyname, void (*fcn_ptr)() );
 490 void do_template(void *templatename);
 491 int lingering_close(int fd);
 492 char *memreadline(char *start, char *buf, int maxlen);
 493 int num_tokens (char *source, char tok);
 494 void extract_token(char *dest, const char *source, int parmnum, char separator, int maxlen);
 495 void remove_token(char *source, int parmnum, char separator);
 496 char *load_mimepart(long msgnum, char *partnum);
 497 int pattern2(char *search, char *patn);
 498 void do_edit_vcard(long, char *, char *);
 499 void edit_vcard(void);
 500 void submit_vcard(void);
 501 void striplt(char *);
 502 void select_user_to_edit(char *message, char *preselect);
 503 void delete_user(char *);
 504 void display_edituser(char *who, int is_new);
 505 void create_user(void);
 506 void edituser(void);
 507 void do_change_view(int);
 508 void change_view(void);
 509 void folders(void);
 510 void load_preferences(void);
 511 void save_preferences(void);
 512 void get_preference(char *key, char *value, size_t value_len);
 513 void set_preference(char *key, char *value, int save_to_server);
 514 void knrooms(void);
 515 int is_msg_in_mset(char *mset, long msgnum);
 516 char *safestrncpy(char *dest, const char *src, size_t n);
 517 void display_addressbook(long msgnum, char alpha);
 518 void offer_start_page(void);
 519 void convenience_page(char *titlebarcolor, char *titlebarmsg, char *messagetext);
 520 void change_start_page(void);
 521 void output_html(char *);
 522 void display_floorconfig(char *);
 523 void delete_floor(void);
 524 void create_floor(void);
 525 void rename_floor(void);
 526 void do_listsub(void);
 527 void toggle_self_service(void);
 528 void summary(void);
 529 void summary_inner_div(void);
 530 ssize_t write(int fd, const void *buf, size_t count);
 531 void cal_process_attachment(char *part_source, long msgnum, char *cal_partnum);
 532 void display_calendar(long msgnum);
 533 void display_task(long msgnum);
 534 void display_note(long msgnum);
 535 void do_calendar_view(void);
 536 void do_tasks_view(void);
 537 void free_calendar_buffer(void);
 538 void calendar_summary_view(void);
 539 int load_msg_ptrs(char *servcmd, int with_headers);
 540 void CtdlEncodeBase64(char *dest, const char *source, size_t sourcelen);
 541 int CtdlDecodeBase64(char *dest, const char *source, size_t length);
 542 void free_attachments(struct wcsession *sess);
 543 void set_room_policy(void);
 544 void display_inetconf(void);
 545 void save_inetconf(void);
 546 void generate_uuid(char *);
 547 void CtdlMakeTempFileName(char *, int);
 548 void display_preferences(void);
 549 void set_preferences(void);
 550 void recp_autocomplete(char *);
 551 void begin_ajax_response(void);
 552 void end_ajax_response(void);
 553 void initialize_viewdefs(void);
 554 void initialize_axdefs(void);
 555
 556 #ifdef WEBCIT_WITH_CALENDAR_SERVICE
 557 void display_edit_task(void);
 558 void save_task(void);
 559 void display_edit_event(void);
 560 void save_event(void);
 561 void display_icaltimetype_as_webform(struct icaltimetype *, char *);
 562 void icaltime_from_webform(struct icaltimetype *result, char *prefix);
 563 void icaltime_from_webform_dateonly(struct icaltimetype *result, char *prefix);
 564 void display_edit_individual_event(icalcomponent *supplied_vtodo, long msgnum);
 565 void save_individual_event(icalcomponent *supplied_vtodo, long msgnum);
 566 void respond_to_request(void);
 567 void handle_rsvp(void);
 568 void ical_dezonify(icalcomponent *cal);
 569 void partstat_as_string(char *buf, icalproperty *attendee);
 570 icalcomponent *ical_encapsulate_subcomponent(icalcomponent *subcomp);
 571 void check_attendee_availability(icalcomponent *supplied_vevent);
 572 void do_freebusy(char *req);
 573 #endif
 574
 575 extern char *months[];
 576 extern char *days[];
 577 void read_server_binary(char *buffer, size_t total_len);
 578 char *read_server_text(void);
 579 int goto_config_room(void);
 580 long locate_user_vcard(char *username, long usernum);
 581 void sleeeeeeeeeep(int);
 582 void http_transmit_thing(char *thing, size_t length, char *content_type,
 583                          int is_static);
 584 void unescape_input(char *buf);
 585 void do_iconbar(void);
 586 void do_iconbar_roomlist(void);
 587 void display_customize_iconbar(void);
 588 void commit_iconbar(void);
 589 int CtdlDecodeQuotedPrintable(char *decoded, char *encoded, int sourcelen);
 590 void spawn_another_worker_thread(void);
 591 void display_rss(char *roomname, char *request_method);
 592
 593 void embed_room_banner(char *, int);
 594 /* navbar types that can be passed to embed_room_banner */
 595 enum {
 596         navbar_none,
 597         navbar_default
 598 };
 599
 600
 601 #ifdef HAVE_OPENSSL
 602 void init_ssl(void);
 603 void endtls(void);
 604 void ssl_lock(int mode, int n, const char *file, int line);
 605 int starttls(int sock);
 606 extern SSL_CTX *ssl_ctx;
 607 int client_read_ssl(char *buf, int bytes, int timeout);
 608 void client_write_ssl(char *buf, int nbytes);
 609 #endif
 610
 611 #ifdef HAVE_ZLIB
 612 #include <zlib.h>
 613 int ZEXPORT compress_gzip(Bytef * dest, uLongf * destLen,
 614                           const Bytef * source, uLong sourceLen, int level);
 615 #endif
 616
 617 #ifdef HAVE_ICONV
 618 void utf8ify_rfc822_string(char *buf);
 619 #endif
 620
 621 void begin_burst(void);
 622 void end_burst(void);
 623
 624 extern char *ascmonths[];
 625 extern char *hourname[];
 626 void http_datestring(char *buf, size_t n, time_t xtime);
 627
 628 /* Views (from citadel.h) */
 629 #define VIEW_BBS                0       /* Traditional Citadel BBS view */
 630 #define VIEW_MAILBOX            1       /* Mailbox summary */
 631 #define VIEW_ADDRESSBOOK        2       /* Address book view */
 632 #define VIEW_CALENDAR           3       /* Calendar view */
 633 #define VIEW_TASKS              4       /* Tasks view */
 634 #define VIEW_NOTES              5       /* Notes view */
 635
 636
 637 /* These should be empty, but we have them for testing */
 638 #define DEFAULT_HTTPAUTH_USER   ""
 639 #define DEFAULT_HTTPAUTH_PASS   ""
 640