webcit/webcit.h

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