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