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