webcit/webcit.h

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