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             /* This version of WebCit */
  31 #define MINIMUM_CIT_VERSION     605             /* min required Citadel vers */
  32 #define DEFAULT_HOST            "localhost"     /* Default Citadel server */
  33 #define DEFAULT_PORT            "504"
  34 #define LB                      (1)             /* Internal escape chars */
  35 #define RB                      (2)
  36 #define QU                      (3)
  37 #define TARGET                  "webcit01"      /* Target for inline URL's */
  38 #define HOUSEKEEPING            15              /* Housekeeping frequency */
  39 #define INITIAL_WORKER_THREADS  5
  40 #define LISTEN_QUEUE_LENGTH     100             /* listen() backlog queue */
  41
  42 #define USERCONFIGROOM          "My Citadel Config"
  43
  44
  45 /*
  46  * Room flags (from Citadel)
  47  *
  48  * bucket one...
  49  */
  50 #define QR_PERMANENT    1               /* Room does not purge              */
  51 #define QR_INUSE        2               /* Set if in use, clear if avail    */
  52 #define QR_PRIVATE      4               /* Set for any type of private room */
  53 #define QR_PASSWORDED   8               /* Set if there's a password too    */
  54 #define QR_GUESSNAME    16              /* Set if it's a guessname room     */
  55 #define QR_DIRECTORY    32              /* Directory room                   */
  56 #define QR_UPLOAD       64              /* Allowed to upload                */
  57 #define QR_DOWNLOAD     128             /* Allowed to download              */
  58 #define QR_VISDIR       256             /* Visible directory                */
  59 #define QR_ANONONLY     512             /* Anonymous-Only room              */
  60 #define QR_ANONOPT      1024            /* Anonymous-Option room            */
  61 #define QR_NETWORK      2048            /* Shared network room              */
  62 #define QR_PREFONLY     4096            /* Preferred status needed to enter */
  63 #define QR_READONLY     8192            /* Aide status required to post     */
  64 #define QR_MAILBOX      16384           /* Set if this is a private mailbox */
  65
  66 /*
  67  * bucket two...
  68  */
  69 #define QR2_SYSTEM      1               /* System room; hide by default     */
  70 #define QR2_SELFLIST    2               /* Self-service mailing list mgmt   */
  71
  72
  73 struct httprequest {
  74         struct httprequest *next;
  75         char line[SIZ];
  76 };
  77
  78 struct urlcontent {
  79         struct urlcontent *next;
  80         char url_key[32];
  81         char *url_data;
  82 };
  83
  84 struct serv_info {
  85         int serv_pid;
  86         char serv_nodename[32];
  87         char serv_humannode[64];
  88         char serv_fqdn[64];
  89         char serv_software[64];
  90         int serv_rev_level;
  91         char serv_bbs_city[64];
  92         char serv_sysadm[64];
  93         char serv_moreprompt[SIZ];
  94         int serv_ok_floors;
  95 };
  96
  97
  98
  99 /*
 100  * This struct holds a list of rooms for <G>oto operations.
 101  */
 102 struct march {
 103         struct march *next;
 104         char march_name[32];
 105         int march_floor;
 106         int march_order;
 107 };
 108
 109 /*
 110  * This struct holds a list of rooms for client display.
 111  * (oooh, a tree!)
 112  */
 113 struct roomlisting {
 114         struct roomlisting *lnext;
 115         struct roomlisting *rnext;
 116         char rlname[64];
 117         unsigned rlflags;
 118         int rlfloor;
 119         int rlorder;
 120 };
 121
 122
 123
 124 /*
 125  * Dynamic content for variable substitution in templates
 126  */
 127 struct wcsubst {
 128         struct wcsubst *next;
 129         int wcs_type;
 130         char wcs_key[32];
 131         void *wcs_value;
 132         void (*wcs_function)(void);
 133 };
 134
 135 /*
 136  * Values for wcs_type
 137  */
 138 enum {
 139         WCS_STRING,
 140         WCS_FUNCTION,
 141         WCS_SERVCMD
 142 };
 143
 144
 145 /*
 146  * One of these is kept for each active Citadel session.
 147  * HTTP transactions are bound to one at a time.
 148  */
 149 struct wcsession {
 150         struct wcsession *next;         /* Linked list */
 151         int wc_session;                 /* WebCit session ID */
 152         char wc_username[SIZ];
 153         char wc_password[SIZ];
 154         char wc_roomname[SIZ];
 155         int connected;
 156         int logged_in;
 157         int axlevel;
 158         int is_aide;
 159         int is_room_aide;
 160         int http_sock;
 161         int serv_sock;
 162         unsigned room_flags;
 163         int wc_view;
 164         int wc_default_view;
 165         char ugname[128];
 166         long uglsn;
 167         int upload_length;
 168         char *upload;
 169         int new_mail;
 170         int remember_new_mail;
 171         int need_regi;                  /* This user needs to register. */
 172         int need_vali;                  /* New users require validation. */
 173         char cs_inet_email[SIZ];        /* User's preferred Internet addr. */
 174         pthread_mutex_t SessionMutex;   /* mutex for exclusive access */
 175         time_t lastreq;                 /* Timestamp of most recent HTTP */
 176         int killthis;                   /* Nonzero == purge this session */
 177         struct march *march;            /* march mode room list */
 178         char reply_to[SIZ];             /* reply-to address */
 179         long msgarr[4096];              /* for read operations */
 180         int fake_frames;
 181         int is_wap;                     /* Client is a WAP gateway */
 182         struct urlcontent *urlstrings;
 183         int HaveExpressMessages;        /* Nonzero if incoming msgs exist */
 184         struct wcsubst *vars;
 185         char this_page[SIZ];            /* address of current page */
 186         char http_host[SIZ];            /* HTTP Host: header */
 187         char *preferences;
 188 #ifdef HAVE_ICAL_H
 189         icalcomponent **disp_cal;       /* store calendar items for display */
 190         long *cal_msgnum;               /* store calendar msgids for display */
 191         int num_cal;
 192 #endif
 193 };
 194
 195 #define extract(dest,source,parmnum)    extract_token(dest,source,parmnum,'|')
 196 #define num_parms(source)               num_tokens(source, '|')
 197
 198 #define WC ((struct wcsession *)pthread_getspecific(MyConKey))
 199 extern pthread_key_t MyConKey;
 200
 201 struct serv_info serv_info;
 202 extern char floorlist[128][SIZ];
 203 extern char *axdefs[];
 204 extern char *defaulthost, *defaultport;
 205 extern char *server_cookie;
 206
 207 extern struct wcsubst *global_subst;
 208
 209
 210 void stuff_to_cookie(char *cookie, int session,
 211                         char *user, char *pass, char *room);
 212 void cookie_to_stuff(char *cookie, int *session,
 213                         char *user, char *pass, char *room);
 214 void locate_host(char *, int);
 215 void become_logged_in(char *, char *, char *);
 216 void do_login(void);
 217 void display_login(char *mesg);
 218 void do_welcome(void);
 219 void do_logout(void);
 220 void display_main_menu(void);
 221 void display_advanced_menu(void);
 222 void list_all_rooms_by_floor(void);
 223 void slrp_highest(void);
 224 void gotonext(void);
 225 void ungoto(void);
 226 void get_serv_info(char *, char *);
 227 int uds_connectsock(char *);
 228 int tcp_connectsock(char *, char *);
 229 void serv_gets(char *strbuf);
 230 void serv_puts(char *string);
 231 void whobbs(void);
 232 void fmout(FILE * fp);
 233 void wDumpContent(int);
 234 void serv_printf(const char *format,...);
 235 char *bstr(char *key);
 236 void urlesc(char *, char *);
 237 void urlescputs(char *);
 238 void output_headers(int);
 239 void wprintf(const char *format,...);
 240 void output_static(char *what);
 241 void stresc(char *target, char *strbuf, int nbsp);
 242 void escputs(char *strbuf);
 243 void url(char *buf);
 244 void escputs1(char *strbuf, int nbsp);
 245 long extract_long(char *source, long int parmnum);
 246 int extract_int(char *source, int parmnum);
 247 void stripout(char *str, char leftboundary, char rightboundary);
 248 void dump_vars(void);
 249 void embed_main_menu(void);
 250 void serv_read(char *buf, int bytes);
 251 int haschar(char *, char);
 252 void readloop(char *oper);
 253 void text_to_server(char *ptr, int convert_to_html);
 254 void display_enter(void);
 255 void post_message(void);
 256 void confirm_delete_msg(void);
 257 void delete_msg(void);
 258 void confirm_move_msg(void);
 259 void move_msg(void);
 260 void userlist(void);
 261 void showuser(void);
 262 void display_page(void);
 263 void page_user(void);
 264 void do_chat(void);
 265 void display_private(char *rname, int req_pass);
 266 void goto_private(void);
 267 void zapped_list(void);
 268 void display_zap(void);
 269 void zap(void);
 270 void display_error(char *);
 271 void display_success(char *);
 272 void display_entroom(void);
 273 void entroom(void);
 274 void display_editroom(void);
 275 void netedit(void);
 276 void editroom(void);
 277 void display_whok(void);
 278 void server_to_text(void);
 279 void save_edit(char *description, char *enter_cmd, int regoto);
 280 void display_edit(char *description, char *check_cmd,
 281                   char *read_cmd, char *save_cmd);
 282 void gotoroom(char *gname, int display_name);
 283 void confirm_delete_room(void);
 284 void delete_room(void);
 285 void validate(void);
 286 void display_graphics_upload(char *, char *, char *);
 287 void do_graphics_upload(char *upl_cmd);
 288 void serv_read(char *buf, int bytes);
 289 void serv_gets(char *strbuf);
 290 void serv_write(char *buf, int nbytes);
 291 void serv_puts(char *string);
 292 void serv_printf(const char *format,...);
 293 void load_floorlist(void);
 294 void display_reg(int);
 295 void register_user(void);
 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 #endif
 387
 388 extern char *months[];
 389 extern char *days[];
 390 void read_server_binary(char *buffer, size_t total_len);
 391 void sleeeeeeeeeep(int);