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