webcit/webcit.h

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