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