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