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