webcit/webcit.h

   1 /* $Id$ */
   2
   3 #ifdef HAVE_ZLIB_H
   4 #include <zlib.h>
   5 #endif
   6
   7
   8 #ifdef HAVE_ICAL_H
   9 #ifdef HAVE_LIBICAL
  10 #define WEBCIT_WITH_CALENDAR_SERVICE 1
  11 #endif
  12 #endif
  13
  14 #ifdef WEBCIT_WITH_CALENDAR_SERVICE
  15 #include <ical.h>
  16 #endif
  17
  18 #define CALENDAR_ROOM_NAME      "Calendar"
  19 #define PRODID "-//Citadel//NONSGML Citadel Calendar//EN"
  20
  21 #define SIZ                     4096            /* generic buffer size */
  22
  23 #define TRACE fprintf(stderr, "Checkpoint: %s, %d\n", __FILE__, __LINE__)
  24
  25 #define SLEEPING                180             /* TCP connection timeout */
  26 #define WEBCIT_TIMEOUT          900             /* WebCit session timeout */
  27 #define PORT_NUM                2000            /* port number to listen on */
  28 #define SERVER                  "WebCit v5.05"  /* who's in da house */
  29 #define DEVELOPER_ID            0
  30 #define CLIENT_ID               4
  31 #define CLIENT_VERSION          505             /* This version of WebCit */
  32 #define MINIMUM_CIT_VERSION     611             /* min required Citadel vers */
  33 #define DEFAULT_HOST            "localhost"     /* Default Citadel server */
  34 #define DEFAULT_PORT            "504"
  35 #define LB                      (1)             /* Internal escape chars */
  36 #define RB                      (2)
  37 #define QU                      (3)
  38 #define TARGET                  "webcit01"      /* Target for inline URL's */
  39 #define HOUSEKEEPING            15              /* Housekeeping frequency */
  40 #define MIN_WORKER_THREADS      5
  41 #define MAX_WORKER_THREADS      250
  42 #define LISTEN_QUEUE_LENGTH     100             /* listen() backlog queue */
  43
  44 #define USERCONFIGROOM          "My Citadel Config"
  45
  46
  47 /*
  48  * Room flags (from Citadel)
  49  *
  50  * bucket one...
  51  */
  52 #define QR_PERMANENT    1               /* Room does not purge              */
  53 #define QR_INUSE        2               /* Set if in use, clear if avail    */
  54 #define QR_PRIVATE      4               /* Set for any type of private room */
  55 #define QR_PASSWORDED   8               /* Set if there's a password too    */
  56 #define QR_GUESSNAME    16              /* Set if it's a guessname room     */
  57 #define QR_DIRECTORY    32              /* Directory room                   */
  58 #define QR_UPLOAD       64              /* Allowed to upload                */
  59 #define QR_DOWNLOAD     128             /* Allowed to download              */
  60 #define QR_VISDIR       256             /* Visible directory                */
  61 #define QR_ANONONLY     512             /* Anonymous-Only room              */
  62 #define QR_ANONOPT      1024            /* Anonymous-Option room            */
  63 #define QR_NETWORK      2048            /* Shared network room              */
  64 #define QR_PREFONLY     4096            /* Preferred status needed to enter */
  65 #define QR_READONLY     8192            /* Aide status required to post     */
  66 #define QR_MAILBOX      16384           /* Set if this is a private mailbox */
  67
  68 /*
  69  * bucket two...
  70  */
  71 #define QR2_SYSTEM      1               /* System room; hide by default     */
  72 #define QR2_SELFLIST    2               /* Self-service mailing list mgmt   */
  73
  74
  75 #define UA_KNOWN                2
  76 #define UA_GOTOALLOWED          4
  77 #define UA_HASNEWMSGS           8
  78 #define UA_ZAPPED               16
  79
  80
  81
  82
  83
  84
  85 struct httprequest {
  86         struct httprequest *next;
  87         char line[SIZ];
  88 };
  89
  90 struct urlcontent {
  91         struct urlcontent *next;
  92         char url_key[32];
  93         char *url_data;
  94 };
  95
  96 struct serv_info {
  97         int serv_pid;
  98         char serv_nodename[32];
  99         char serv_humannode[64];
 100         char serv_fqdn[64];
 101         char serv_software[64];
 102         int serv_rev_level;
 103         char serv_bbs_city[64];
 104         char serv_sysadm[64];
 105         char serv_moreprompt[SIZ];
 106         int serv_ok_floors;
 107         int serv_supports_ldap;
 108 };
 109
 110
 111
 112 /*
 113  * This struct holds a list of rooms for <G>oto operations.
 114  */
 115 struct march {
 116         struct march *next;
 117         char march_name[32];
 118         int march_floor;
 119         int march_order;
 120 };
 121
 122 /*
 123  * This struct holds a list of rooms for client display.
 124  * (oooh, a tree!)
 125  */
 126 struct roomlisting {
 127         struct roomlisting *lnext;
 128         struct roomlisting *rnext;
 129         char rlname[64];
 130         unsigned rlflags;
 131         int rlfloor;
 132         int rlorder;
 133 };
 134
 135
 136
 137 /*
 138  * Dynamic content for variable substitution in templates
 139  */
 140 struct wcsubst {
 141         struct wcsubst *next;
 142         int wcs_type;
 143         char wcs_key[32];
 144         void *wcs_value;
 145         void (*wcs_function)(void);
 146 };
 147
 148 /*
 149  * Values for wcs_type
 150  */
 151 enum {
 152         WCS_STRING,
 153         WCS_FUNCTION,
 154         WCS_SERVCMD
 155 };
 156
 157
 158 struct wc_attachment {
 159         struct wc_attachment *next;
 160         size_t length;
 161         char content_type[SIZ];
 162         char filename[SIZ];
 163         char *data;
 164 };
 165
 166
 167 /*
 168  * One of these is kept for each active Citadel session.
 169  * HTTP transactions are bound to one at a time.
 170  */
 171 struct wcsession {
 172         struct wcsession *next;         /* Linked list */
 173         int wc_session;                 /* WebCit session ID */
 174         char wc_username[SIZ];
 175         char wc_password[SIZ];
 176         char wc_roomname[SIZ];
 177         int connected;
 178         int logged_in;
 179         int axlevel;
 180         int is_aide;
 181         int is_room_aide;
 182         int http_sock;
 183         int serv_sock;
 184         unsigned room_flags;
 185         int wc_view;
 186         int wc_default_view;
 187         char ugname[128];
 188         long uglsn;
 189         int upload_length;
 190         char *upload;
 191         char upload_filename[SIZ];
 192         char upload_content_type[SIZ];
 193         int new_mail;
 194         int remember_new_mail;
 195         int need_regi;                  /* This user needs to register. */
 196         int need_vali;                  /* New users require validation. */
 197         char cs_inet_email[SIZ];        /* User's preferred Internet addr. */
 198         pthread_mutex_t SessionMutex;   /* mutex for exclusive access */
 199         time_t lastreq;                 /* Timestamp of most recent HTTP */
 200         int killthis;                   /* Nonzero == purge this session */
 201         struct march *march;            /* march mode room list */
 202         char reply_to[SIZ];             /* reply-to address */
 203         long msgarr[4096];              /* for read operations */
 204         int fake_frames;
 205         int is_wap;                     /* Client is a WAP gateway */
 206         struct urlcontent *urlstrings;
 207         int HaveExpressMessages;        /* Nonzero if incoming msgs exist */
 208         struct wcsubst *vars;
 209         char this_page[SIZ];            /* address of current page */
 210         char http_host[SIZ];            /* HTTP Host: header */
 211         char *preferences;
 212 #ifdef WEBCIT_WITH_CALENDAR_SERVICE
 213         icalcomponent **disp_cal;       /* store calendar items for display */
 214         long *cal_msgnum;               /* store calendar msgids for display */
 215         int num_cal;
 216 #endif
 217         struct wc_attachment *first_attachment;
 218         char ImportantMessage[SIZ];
 219         int outside_frameset_allowed;   /* nonzero if current req is allowed
 220                                          * outside of the main frameset */
 221 };
 222
 223 #define extract(dest,source,parmnum)    extract_token(dest,source,parmnum,'|')
 224 #define num_parms(source)               num_tokens(source, '|')
 225
 226 #define WC ((struct wcsession *)pthread_getspecific(MyConKey))
 227 extern pthread_key_t MyConKey;
 228
 229 struct serv_info serv_info;
 230 extern char floorlist[128][SIZ];
 231 extern char *axdefs[];
 232 extern char *ctdlhost, *ctdlport;
 233 extern char *server_cookie;
 234
 235 extern struct wcsubst *global_subst;
 236
 237
 238 void stuff_to_cookie(char *cookie, int session,
 239                         char *user, char *pass, char *room);
 240 void cookie_to_stuff(char *cookie, int *session,
 241                         char *user, char *pass, char *room);
 242 void locate_host(char *, int);
 243 void become_logged_in(char *, char *, char *);
 244 void do_login(void);
 245 void display_login(char *mesg);
 246 void do_welcome(void);
 247 void do_logout(void);
 248 void display_main_menu(void);
 249 void display_advanced_menu(void);
 250 void slrp_highest(void);
 251 void gotonext(void);
 252 void ungoto(void);
 253 void get_serv_info(char *, char *);
 254 int uds_connectsock(char *);
 255 int tcp_connectsock(char *, char *);
 256 void serv_gets(char *strbuf);
 257 void serv_puts(char *string);
 258 void whobbs(void);
 259 void fmout(FILE *fp, char *align);
 260 void wDumpContent(int);
 261 void serv_printf(const char *format,...);
 262 char *bstr(char *key);
 263 void urlesc(char *, char *);
 264 void urlescputs(char *);
 265 void output_headers(int);
 266 void wprintf(const char *format,...);
 267 void output_static(char *what);
 268 void stresc(char *target, char *strbuf, int nbsp);
 269 void escputs(char *strbuf);
 270 void url(char *buf);
 271 void escputs1(char *strbuf, int nbsp);
 272 long extract_long(char *source, long int parmnum);
 273 int extract_int(char *source, int parmnum);
 274 void stripout(char *str, char leftboundary, char rightboundary);
 275 void dump_vars(void);
 276 void embed_main_menu(void);
 277 void serv_read(char *buf, int bytes);
 278 int haschar(char *, char);
 279 void readloop(char *oper);
 280 void text_to_server(char *ptr, int convert_to_html);
 281 void display_enter(void);
 282 void post_message(void);
 283 void confirm_delete_msg(void);
 284 void delete_msg(void);
 285 void confirm_move_msg(void);
 286 void move_msg(void);
 287 void userlist(void);
 288 void showuser(void);
 289 void display_page(void);
 290 void page_user(void);
 291 void do_chat(void);
 292 void display_private(char *rname, int req_pass);
 293 void goto_private(void);
 294 void zapped_list(void);
 295 void display_zap(void);
 296 void zap(void);
 297 void display_success(char *);
 298 void display_entroom(void);
 299 void entroom(void);
 300 void display_editroom(void);
 301 void netedit(void);
 302 void editroom(void);
 303 void display_whok(void);
 304 void server_to_text(void);
 305 void save_edit(char *description, char *enter_cmd, int regoto);
 306 void display_edit(char *description, char *check_cmd,
 307                   char *read_cmd, char *save_cmd, int headers_type);
 308 void gotoroom(char *gname, int display_name);
 309 void confirm_delete_room(void);
 310 void delete_room(void);
 311 void validate(void);
 312 void display_graphics_upload(char *, char *, char *);
 313 void do_graphics_upload(char *upl_cmd);
 314 void serv_read(char *buf, int bytes);
 315 void serv_gets(char *strbuf);
 316 void serv_write(char *buf, int nbytes);
 317 void serv_puts(char *string);
 318 void serv_printf(const char *format,...);
 319 void load_floorlist(void);
 320 void display_reg(int);
 321 void display_changepw(void);
 322 void changepw(void);
 323 void display_edit_node(void);
 324 void edit_node(void);
 325 void display_netconf(void);
 326 void display_confirm_delete_node(void);
 327 void delete_node(void);
 328 void display_add_node(void);
 329 void add_node(void);
 330 void terminate_session(void);
 331 void edit_me(void);
 332 void display_siteconfig(void);
 333 void siteconfig(void);
 334 void display_generic(void);
 335 void do_generic(void);
 336 void display_menubar(int);
 337 void embed_room_banner(char *);
 338 void smart_goto(char *);
 339 void worker_entry(void);
 340 void session_loop(struct httprequest *);
 341 void fmt_date(char *buf, time_t thetime);
 342 void fmt_time(char *buf, time_t thetime);
 343 void httpdate(char *buf, time_t thetime);
 344 void end_webcit_session(void);
 345 void page_popup(void);
 346 void http_redirect(char *);
 347 void clear_local_substs(void);
 348 void svprintf(char *keyname, int keytype, const char *format,...);
 349 void svcallback(char *keyname, void (*fcn_ptr)() );
 350 void do_template(void *templatename);
 351 int lingering_close(int fd);
 352 char *memreadline(char *start, char *buf, int maxlen);
 353 int num_tokens (char *source, char tok);
 354 void extract_token(char *dest, char *source, int parmnum, char separator);
 355 void remove_token(char *source, int parmnum, char separator);
 356 char *load_mimepart(long msgnum, char *partnum);
 357 int pattern2(char *search, char *patn);
 358 void do_edit_vcard(long, char *, char *);
 359 void edit_vcard(void);
 360 void submit_vcard(void);
 361 void striplt(char *);
 362 void select_user_to_edit(char *message, char *preselect);
 363 void display_edituser(char *who);
 364 void create_user(void);
 365 void edituser(void);
 366 void change_view(void);
 367 void folders(void);
 368 void do_stuff_to_msgs(void);
 369 void load_preferences(void);
 370 void save_preferences(void);
 371 void get_preference(char *key, char *value);
 372 void set_preference(char *key, char *value);
 373 void knrooms(void);
 374 int is_msg_in_mset(char *mset, long msgnum);
 375 char *safestrncpy(char *dest, const char *src, size_t n);
 376 void display_addressbook(long msgnum, char alpha);
 377 void offer_start_page(void);
 378 void change_start_page(void);
 379 void output_html(void);
 380 void display_floorconfig(char *);
 381 void delete_floor(void);
 382 void create_floor(void);
 383 void rename_floor(void);
 384 void do_listsub(void);
 385 void toggle_self_service(void);
 386 void summary(void);
 387 ssize_t write(int fd, const void *buf, size_t count);
 388 void cal_process_attachment(char *part_source, long msgnum, char *cal_partnum);
 389 void display_calendar(long msgnum);
 390 void display_task(long msgnum);
 391 void do_calendar_view(void);
 392 void free_calendar_buffer(void);
 393 void calendar_summary_view(void);
 394 int load_msg_ptrs(char *servcmd);
 395 void CtdlEncodeBase64(char *dest, const char *source, size_t sourcelen);
 396 int CtdlDecodeBase64(char *dest, const char *source, size_t length);
 397 void free_attachments(struct wcsession *sess);
 398
 399
 400 #ifdef WEBCIT_WITH_CALENDAR_SERVICE
 401 void display_edit_task(void);
 402 void save_task(void);
 403 void display_edit_event(void);
 404 void save_event(void);
 405 void display_icaltimetype_as_webform(struct icaltimetype *, char *);
 406 struct icaltimetype icaltime_from_webform(char *prefix);
 407 void display_edit_individual_event(icalcomponent *supplied_vtodo, long msgnum);
 408 void save_individual_event(icalcomponent *supplied_vtodo, long msgnum);
 409 void generate_new_uid(char *);
 410 void respond_to_request(void);
 411 void handle_rsvp(void);
 412 void ical_dezonify(icalcomponent *cal);
 413 void partstat_as_string(char *buf, icalproperty *attendee);
 414 icalcomponent *ical_encapsulate_subcomponent(icalcomponent *subcomp);
 415 void check_attendee_availability(icalcomponent *supplied_vevent);
 416 void do_freebusy(char *req);
 417 #endif
 418
 419 extern char *months[];
 420 extern char *days[];
 421 void read_server_binary(char *buffer, size_t total_len);
 422 char *read_server_text(void);
 423 int goto_config_room(void);
 424 long locate_user_vcard(char *username, long usernum);
 425 void sleeeeeeeeeep(int);
 426 void http_transmit_thing(char *thing, size_t length, char *content_type,
 427                          int is_static);
 428 void unescape_input(char *buf);
 429 void do_iconbar(void);
 430 void display_customize_iconbar(void);
 431 void commit_iconbar(void);
 432 int CtdlDecodeQuotedPrintable(char *decoded, char *encoded, int sourcelen);
 433 void spawn_another_worker_thread(void);