Remove $Id$ tags from most of webcit
[citadel.git] / webcit / webcit.h
index b65683c9c2ab0dae5d6c9b59db745e1a392715d0..725606d74c94805cd6808467be5cf700b1172ba3 100644 (file)
@@ -1,5 +1,4 @@
-/* $Id$
- *
+/*
  * Copyright (c) 1987-2010 by the citadel.org team
  *
  * This program is free software; you can redistribute it and/or modify
 #ifdef HAVE_LIMITS_H
 #include <limits.h>
 #endif
+#include <sys/socket.h>
 #include <netinet/in.h>
 #include <arpa/inet.h>
-#include <sys/un.h>
 #include <netdb.h>
+#include <sys/un.h>
 #include <sys/poll.h>
 #include <string.h>
 #include <pwd.h>
 #include <sys/utsname.h>
 #include <libcitadel.h>
 
-#ifndef INADDR_NONE
-#define INADDR_NONE 0xffffffff
-#endif
-
 #ifdef HAVE_ICONV
 #include <iconv.h>
 #endif
@@ -114,6 +110,17 @@ extern char *ssl_cipher_list;
 #define        DEFAULT_SSL_CIPHER_LIST "DEFAULT"       /* See http://openssl.org/docs/apps/ciphers.html */
 #endif
 
+#if SIZEOF_SIZE_T == SIZEOF_INT 
+#define SIZE_T_FMT "%d"
+#else
+#define SIZE_T_FMT "%ld"
+#endif
+
+#if SIZEOF_LONG_UNSIGNED_INT == SIZEOF_INT
+#define ULONG_FMT "%d"
+#else
+#define ULONG_FMT "%ld"
+#endif
 
 #define CALENDAR_ROOM_NAME     "Calendar"
 #define PRODID "-//Citadel//NONSGML Citadel Calendar//EN"
@@ -127,14 +134,13 @@ extern char *ssl_cipher_list;
 #define PORT_NUM               2000            /* port number to listen on */
 #define DEVELOPER_ID           0
 #define CLIENT_ID              4
-#define CLIENT_VERSION         780             /* This version of WebCit */
-#define MINIMUM_CIT_VERSION    780             /* min required Citadel ver */
-#define        LIBCITADEL_MIN          780             /* min required libcitadel ver */
+#define CLIENT_VERSION         783             /* This version of WebCit */
+#define MINIMUM_CIT_VERSION    781             /* min required Citadel ver */
+#define        LIBCITADEL_MIN          781             /* min required libcitadel ver */
 #define DEFAULT_HOST           "localhost"     /* Default Citadel server */
 #define DEFAULT_PORT           "504"
 #define TARGET                 "webcit01"      /* Target for inline URL's */
 #define HOUSEKEEPING           15              /* Housekeeping frequency */
-#define MIN_WORKER_THREADS     5
 #define MAX_WORKER_THREADS     250
 #define LISTEN_QUEUE_LENGTH    100             /* listen() backlog queue */
 
@@ -346,10 +352,19 @@ typedef struct _addrbookent {
 #define ISSTATIC (1<<7)
 #define FORCE_SESSIONCLOSE (1<<8)
 #define PARSE_REST_URL (1<<9)
+#define PROHIBIT_STARTPAGE (1<<10)
+
+typedef enum _RESTDispatchID {
+       ExistsID,
+       PutID,
+       DeleteID
+} RESTDispatchID;
 
+typedef int (*WebcitRESTDispatchID)(RESTDispatchID WhichAction, int IgnoreFloor);
 typedef void (*WebcitHandlerFunc)(void);
 typedef struct  _WebcitHandler{
        WebcitHandlerFunc F;
+       WebcitRESTDispatchID RID;
        long Flags;
        StrBuf *Name;
        StrBuf *DisplayName;
@@ -388,7 +403,7 @@ enum {
        eCOPY,
        eNONE
 };
-const char *ReqStrs[eNONE];
+extern const char *ReqStrs[eNONE];
 
 #define NO_AUTH 0
 #define AUTH_COOKIE 1
@@ -465,7 +480,7 @@ struct wcsession {
        StrBuf *ReadBuf;                        /* here we keep our stuff while reading linebuffered from the server. */
        StrBuf *MigrateReadLineBuf;             /* here we buffer legacy server read stuff */
        const char *ReadPos;                    /* whats our read position in ReadBuf? */
-       int chat_sock;                          /* Client socket to Citadel server - for chat */
+       int last_chat_seq;                      /* When in chat - last message seq# we saw */
        time_t lastreq;                         /* Timestamp of most recent HTTP */
        time_t last_pager_check;                /* last time we polled for instant msgs */
        ServInfo *serv_info;                    /* Information about the citserver we're connected to */
@@ -476,8 +491,8 @@ struct wcsession {
        ParsedHttpHdrs *Hdr;
        StrBuf *WBuf;                           /* Our output buffer */
        StrBuf *HBuf;                           /* Our HeaderBuffer */
+       StrBuf *WFBuf;                          /* Wildfire error logging buffer */
 
-       HashList *vars;                         /* HTTP variable substitutions for this page */
        StrBuf *trailing_javascript;            /* extra javascript to be appended to page */
        char ImportantMessage[SIZ];
        StrBuf *ImportantMsg;
@@ -491,7 +506,6 @@ struct wcsession {
        StrBuf *httpauth_pass;                  /* only for GroupDAV sessions */
        int axlevel;                            /* this user's access level */
        int is_aide;                            /* nonzero == this user is an Aide */
-       int is_room_aide;                       /* nonzero == this user is a Room Aide in this room */
        int connected;                          /* nonzero == we are connected to Citadel */
        int logged_in;                          /* nonzero == we are logged in  */
        int need_regi;                          /* This user needs to register. */
@@ -499,7 +513,6 @@ struct wcsession {
 
 /* Preferences */
        StrBuf *cs_inet_email;                  /* User's preferred Internet addr. */
-       char reply_to[512];                     /* reply-to address */
        HashList *hash_prefs;                   /* WebCit preferences for this user */
        StrBuf *DefaultCharset;                 /* Charset the user preferes */
        int downloaded_prefs;                   /* Has the client download its prefs yet? */
@@ -507,16 +520,6 @@ struct wcsession {
        int selected_language;                  /* Language selected by user */
        int time_format_cache;                  /* which timeformat does our user like? */
 
-/* current room related */
-/*     StrBuf *wc_roomname;                    / * Room we are currently in */
-/*     unsigned room_flags;                    / * flags associated with the current room */
-/*     unsigned room_flags2;                   / * flags associated with the current room */
-/*     int wc_view;                            / * view for the current room */
-/*     int wc_default_view;                    / * default view for the current room */
-/*     int wc_is_trash;                        / * nonzero == current room is a Trash folder */
-/*     int wc_floor;                           / * floor number of current room */
-/*     int is_mailbox;                         / * the current room is a private mailbox */
-
        folder CurRoom;                         /* information about our current room */
        const folder *ThisRoom;                 /* if REST found a room, remember it here. */
 /* next/previous room thingabob */
@@ -528,10 +531,9 @@ struct wcsession {
        HashList *attachments;                  /* list of attachments for 'enter message' */
        int upload_length;                      /* content length of http-uploaded data */
        StrBuf *upload;                         /* pointer to http-uploaded data */
-       char upload_filename[PATH_MAX];         /* filename of http-uploaded data */
+       StrBuf *upload_filename;                /* filename of http-uploaded data */
        char upload_content_type[256];          /* content type of http-uploaded data */
 
-       int new_mail;                           /* user has new mail waiting */
        int remember_new_mail;                  /* last count of new mail messages */
 
 /* Roomiew control */
@@ -549,10 +551,8 @@ struct wcsession {
        char last_chat_user[256];
 
 /* Iconbar controls */
-       struct __ofolder *cache_fold;           /* cache the iconbar room list */
        int cache_max_folders;
        int cache_num_floors;
-       time_t cache_timestamp;
        long *IBSettingsVec;                    /* which icons should be shown / not shown? */
        const StrBuf *floordiv_expanded;        /* which floordiv currently expanded */
 
@@ -577,8 +577,8 @@ void RegisterHeaderHandler(const char *Name, long Len, Header_Evaluator F);
 
 
 enum {
-       S_SELECT,
        S_SHUTDOWN,
+       S_SPAWNER,
        MAX_SEMAPHORES
 };
 
@@ -610,7 +610,8 @@ extern int is_https;
 extern int setup_wizard;
 extern char wizard_filename[];
 extern int follow_xff;
-extern int num_threads;
+extern int num_threads_existing;
+extern int num_threads_executing;
 
 void InitialiseSemaphores(void);
 void begin_critical_section(int which_one);
@@ -634,7 +635,6 @@ void do_welcome(void);
 void do_logout(void);
 void display_main_menu(void);
 void display_aide_menu(void);
-void display_advanced_menu(void);
 void slrp_highest(void);
 ServInfo *get_serv_info(StrBuf *, StrBuf *);
 void RegisterEmbeddableMimeType(const char *MimeType, long MTLen, int Priority);
@@ -648,7 +648,7 @@ int StrBuf_ServGetln(StrBuf *buf);
 int GetServerStatus(StrBuf *Line, long* FullState);
 void serv_puts(const char *string);
 void who(void);
-void who_inner_div(void);
+
 void ajax_mini_calendar(void);
 void fmout(char *align);
 void _fmout(StrBuf *Targt, char *align);
@@ -693,17 +693,14 @@ void msgesc(char *target, size_t tlen, char *strbuf);
 void msgescputs(char *strbuf);
 void msgescputs1(char *strbuf);
 void dump_vars(void);
-void embed_main_menu(void);
 
 void do_addrbook_view(addrbookent *addrbook, int num_ab);
 void fetch_ab_name(message_summary *Msg, char **namebuf);
 void display_vcard(StrBuf *Target, wc_mime_attachment *Mime, char alpha, int full, char **storename, long msgnum);
 void jsonMessageList(void);
 void new_summary_view(void);
-void getseen(void);
 void text_to_server(char *ptr);
 void text_to_server_qp(char *ptr);
-void confirm_delete_msg(void);
 void display_success(char *);
 void CheckAuthBasic(ParsedHttpHdrs *hdr);
 void GetAuthBasic(ParsedHttpHdrs *hdr);
@@ -714,15 +711,12 @@ void display_edit(char *description, char *check_cmd,
 long gotoroom(const StrBuf *gname);
 void remove_march(const StrBuf *aaa);
 void dotskip(void);
-void confirm_delete_room(void);
 void validate(void);
 void display_graphics_upload(char *, char *, char *);
 void do_graphics_upload(char *upl_cmd);
-void serv_gets(char *strbuf);
 void serv_write(const char *buf, int nbytes);
 void serv_putbuf(const StrBuf *string);
 void serv_printf(const char *format,...)__attribute__((__format__(__printf__,1,2)));
-void load_floorlist(StrBuf *Buf);
 void shutdown_sessions(void);
 void do_housekeeping(void);
 void smart_goto(const StrBuf *);
@@ -745,7 +739,6 @@ long extract_token(char *dest, const char *source, int parmnum, char separator,
 void remove_token(char *source, int parmnum, char separator);
 StrBuf *load_mimepart(long msgnum, char *partnum);
 void MimeLoadData(wc_mime_attachment *Mime);
-int pattern2(char *search, char *patn);
 void do_edit_vcard(long msgnum, char *partnum, 
                   message_summary *VCMsg,
                   wc_mime_attachment *VCAtt,
@@ -765,9 +758,6 @@ void output_html(const char *, int, int, StrBuf *, StrBuf *);
 void do_listsub(void);
 ssize_t write(int fd, const void *buf, size_t count);
 void cal_process_attachment(wc_mime_attachment *Mime);
-void display_calendar(message_summary *Msg, int unread);
-void display_note(message_summary *Msg, int unread);
-void updatenote(void);
 void do_tasks_view(void);
 int calendar_summary_view(void);
 void free_march_list(wcsession *wcf);
@@ -777,11 +767,6 @@ void CtdlMakeTempFileName(char *, int);
 void address_book_popup(void);
 void begin_ajax_response(void);
 void end_ajax_response(void);
-void initialize_viewdefs(void);
-void initialize_axdefs(void);
-void burn_folder_cache(time_t age);
-void list_all_rooms_by_floor(const char *viewpref);
-void display_pictureview(void);
 
 void display_edit_task(void);
 void display_edit_event(void);
@@ -811,10 +796,10 @@ long locate_user_vcard_in_this_room(message_summary **VCMsg,
 void sleeeeeeeeeep(int);
 void http_transmit_thing(const char *content_type, int is_static);
 long unescape_input(char *buf);
-void do_selected_iconbar(void);
+void check_thread_pool_size(void);
 void spawn_another_worker_thread(void);
 void StrEndTab(StrBuf *Target, int tabnum, int num_tabs);
-void StrBeginTab(StrBuf *Target, int tabnum, int num_tabs);
+void StrBeginTab(StrBuf *Target, int tabnum, int num_tabs, StrBuf **Names);
 void StrTabbedDialog(StrBuf *Target, int num_tabs, StrBuf *tabnames[]);
 void tabbed_dialog(int num_tabs, char *tabnames[]);
 void begin_tab(int tabnum, int num_tabs);
@@ -830,22 +815,10 @@ void display_wiki_pagelist(void);
 #define DATEFMT_RAWDATE 2
 #define DATEFMT_LOCALEDATE 3
 void webcit_fmt_date(char *buf, size_t siz, time_t thetime, int Format);
-int fetch_http(char *url, char *target_buf, int maxbytes);
-void free_attachments(wcsession *sess);
 void summary(void);
 
 int is_mobile_ua(char *user_agent);
 
-void embed_room_banner(char *, int);
-HashList *GetFloorListHash(StrBuf *Target, WCTemplputParams *TP);
-HashList *GetRoomListHash(StrBuf *Target, WCTemplputParams *TP);
-int SortRoomsByListOrder(const void *room1, const void *room2);
-/* navbar types that can be passed to embed_room_banner */
-enum {
-       navbar_none,
-       navbar_default
-};
-
 /* actual supported locales */
 void TmplGettext(StrBuf *Target, WCTemplputParams *TP);
 void offer_languages(StrBuf *Target, int nArgs, WCTemplateToken *Token, void *Context, int ContextType);
@@ -868,6 +841,8 @@ void utf8ify_rfc822_string(char **buf);
 void begin_burst(void);
 long end_burst(void);
 
+void AppendImportantMessage(const char *pch, long len);
+
 extern char *hourname[];       /* Names of hours (12am, 1am, etc.) */
 
 void http_datestring(char *buf, size_t n, time_t xtime);
@@ -889,3 +864,4 @@ void http_datestring(char *buf, size_t n, time_t xtime);
 #define WC_TIMEFORMAT_AMPM 1
 #define WC_TIMEFORMAT_24 2
 
+extern int time_to_die;                        /* Nonzero if server is shutting down */