webcit/webcit.h

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