X-Git-Url: https://code.citadel.org/?a=blobdiff_plain;f=webcit%2Fwebcit.h;h=5ba500b2b73cf58c9ba9b6ec244009fe05fb0640;hb=c08adcea52e85d6139ad158c17eb3d1941df2eb5;hp=47dcaac38a21bf8454204695565dd8f5f4cb6975;hpb=f9c270e0e7ec5f05da921060ac4d305bdeb07ae6;p=citadel.git diff --git a/webcit/webcit.h b/webcit/webcit.h index 47dcaac38..5ba500b2b 100644 --- a/webcit/webcit.h +++ b/webcit/webcit.h @@ -1,11 +1,23 @@ - -/* $Id$ */ +/* + * Copyright (c) 1987-2010 by the citadel.org team + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ #include "sysdep.h" - - #include - #include #include #ifdef HAVE_UNISTD_H @@ -38,7 +50,6 @@ #include #include #include - #include #ifndef INADDR_NONE @@ -89,6 +100,7 @@ #include "subst.h" #include "messages.h" #include "paramhandling.h" +#include "roomops.h" #include "preferences.h" #ifdef HAVE_OPENSSL @@ -97,6 +109,20 @@ #include #include #include +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" @@ -111,14 +137,13 @@ #define PORT_NUM 2000 /* port number to listen on */ #define DEVELOPER_ID 0 #define CLIENT_ID 4 -#define CLIENT_VERSION 764 /* This version of WebCit */ -#define MINIMUM_CIT_VERSION 761 /* min required Citadel ver */ -#define LIBCITADEL_MIN 763 /* min required libcitadel ver */ +#define CLIENT_VERSION 786 /* This version of WebCit */ +#define MINIMUM_CIT_VERSION 786 /* min required Citadel ver */ +#define LIBCITADEL_MIN 786 /* 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 */ @@ -174,6 +199,7 @@ #define UA_POSTALLOWED 32 #define UA_ADMINALLOWED 64 #define UA_DELETEALLOWED 128 +#define UA_ISTRASH 256 /* Only available in room view... */ /* @@ -197,6 +223,8 @@ US_FLOORS | US_COLOR | US_PROMPTCTL ) + + #define MAJORCODE(a) (((int)(a / 100) ) * 100) #define LISTING_FOLLOWS 100 @@ -238,18 +266,32 @@ */ #define NLI "(not logged in)" +/* + * Expiry policy for the autopurger + */ +#define EXPIRE_NEXTLEVEL 0 /* Inherit expiration policy */ +#define EXPIRE_MANUAL 1 /* Don't expire messages at all */ +#define EXPIRE_NUMMSGS 2 /* Keep only latest n messages */ +#define EXPIRE_AGE 3 /* Expire messages after n days */ +typedef struct __ExpirePolicy { + int loaded; /* has this been loaded from the server? */ + int expire_mode; + int expire_value; +}ExpirePolicy; +void LoadExpirePolicy(GPEXWhichPolicy which); +void SaveExpirePolicyFromHTTP(GPEXWhichPolicy which); /* - * \brief Linked list of session variables encoded in an x-www-urlencoded content type + * Linked list of session variables encoded in an x-www-urlencoded content type */ typedef struct urlcontent urlcontent; struct urlcontent { - char url_key[32]; /* the variable name */ - StrBuf *url_data; /* its value */ + char url_key[32]; /* key */ + StrBuf *url_data; /* value */ }; /* - * \brief information about us ??? + * Information about the Citadel server to which we are connected */ typedef struct _serv_info { int serv_pid; /* Process ID of the Citadel server */ @@ -261,7 +303,6 @@ typedef struct _serv_info { StrBuf *serv_bbs_city; /* Geographic location of the Citadel server */ StrBuf *serv_sysadm; /* Name of system administrator */ StrBuf *serv_moreprompt; /* Whats the commandline textprompt */ - int serv_ok_floors; /* nonzero == server supports floors */ int serv_supports_ldap; /* is the server linked against an ldap tree for adresses? */ int serv_newuser_disabled; /* Has the server disabled self-service new user creation? */ StrBuf *serv_default_cal_zone; /* Default timezone for unspecified calendar items */ @@ -298,8 +339,8 @@ typedef struct _IcalEnumMap { * which we can use to get to the real meat and bones later) */ typedef struct _addrbookent { - char ab_name[64]; /**< name string */ - long ab_msgnum; /**< message number of address book entry */ + char ab_name[64]; /* name string */ + long ab_msgnum; /* message number of address book entry */ } addrbookent; @@ -313,15 +354,27 @@ typedef struct _addrbookent { #define COOKIEUNNEEDED (1<<6) #define ISSTATIC (1<<7) #define FORCE_SESSIONCLOSE (1<<8) -#define PARSE_REST_URL (1<<0) +#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; } WebcitHandler; -void WebcitAddUrlHandler(const char * UrlString, long UrlSLen, WebcitHandlerFunc F, long Flags); + + +void WebcitAddUrlHandler(const char * UrlString, long UrlSLen, const char *DisplayName, long dslen, WebcitHandlerFunc F, long Flags); typedef struct _headereval { ExamineMsgHeaderFunc evaluator; @@ -353,7 +406,7 @@ enum { eCOPY, eNONE }; -const char *ReqStrs[eNONE]; +extern const char *ReqStrs[eNONE]; #define NO_AUTH 0 #define AUTH_COOKIE 1 @@ -362,7 +415,7 @@ const char *ReqStrs[eNONE]; typedef struct _HdrRefs { - long eReqType; /**< eGET, ePOST.... */ + long eReqType; /* HTTP method */ int desired_session; int SessionKey; @@ -370,16 +423,18 @@ typedef struct _HdrRefs { int DontNeedAuth; long ContentLength; time_t if_modified_since; - int gzip_ok; /**< Nonzero if Accept-encoding: gzip */ + int gzip_ok; /* Nonzero if Accept-encoding: gzip */ int prohibit_caching; int dav_depth; + int Static; /* these are references into Hdr->HTTPHeaders, so we don't need to free them. */ StrBuf *ContentType; StrBuf *RawCookie; StrBuf *ReqLine; - StrBuf *http_host; /**< HTTP Host: header */ + StrBuf *http_host; /* HTTP Host: header */ StrBuf *browser_host; + StrBuf *browser_language; StrBuf *user_agent; StrBuf *plainauth; StrBuf *dav_ifmatch; @@ -388,7 +443,7 @@ typedef struct _HdrRefs { } HdrRefs; typedef struct _ParsedHttpHdrs { - int http_sock; /**< HTTP server socket */ + int http_sock; /* HTTP server socket */ const char *Pos; StrBuf *ReadBuf; @@ -396,12 +451,12 @@ typedef struct _ParsedHttpHdrs { StrBuf *c_password; StrBuf *c_roomname; StrBuf *c_language; - StrBuf *this_page; /**< URL of current page */ + StrBuf *this_page; /* URL of current page */ StrBuf *PlainArgs; - HashList *urlstrings; /**< variables passed to webcit in a URL */ - HashList *HTTPHeaders; /**< the headers the client sent us */ - int nWildfireHeaders; /**< how many wildfire headers did we already send? */ + HashList *urlstrings; /* variables passed to webcit in a URL */ + HashList *HTTPHeaders; /* the headers the client sent us */ + int nWildfireHeaders; /* how many wildfire headers did we already send? */ HdrRefs HR; } ParsedHttpHdrs; @@ -414,112 +469,106 @@ typedef struct _ParsedHttpHdrs { typedef struct wcsession wcsession; struct wcsession { /* infrastructural members */ - wcsession *next; /**< Linked list */ - pthread_mutex_t SessionMutex; /**< mutex for exclusive access */ - int wc_session; /**< WebCit session ID */ - int killthis; /**< Nonzero == purge this session */ - int is_mobile; /**< Client is a handheld browser */ - int ctdl_pid; /**< Session ID on the Citadel server */ - int nonce; /**< session nonce (to prevent session riding) */ + wcsession *next; /* Linked list */ + pthread_mutex_t SessionMutex; /* mutex for exclusive access */ + int wc_session; /* WebCit session ID */ + int killthis; /* Nonzero == purge this session */ + int is_mobile; /* Client is a handheld browser */ + int ctdl_pid; /* Session ID on the Citadel server */ + int nonce; /* session nonce (to prevent session riding) */ int SessionKey; /* Session local Members */ - int serv_sock; /**< Client socket to Citadel server */ - 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 */ - time_t lastreq; /**< Timestamp of most recent HTTP */ - time_t last_pager_check; /**< last time we polled for instant msgs */ - ServInfo *serv_info; /**< Iformation about the citserver we're connected to */ - int is_ajax; /** < are we doing an ajax request? */ + int serv_sock; /* Client socket to Citadel server */ + 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 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 */ + int is_ajax; /* are we doing an ajax request? */ /* Request local Members */ - StrBuf *CLineBuf; /**< linebuffering client stuff */ + StrBuf *CLineBuf; /* linebuffering client stuff */ ParsedHttpHdrs *Hdr; - StrBuf *WBuf; /**< Our output buffer */ - StrBuf *HBuf; /**< Our HeaderBuffer */ + 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]; /**< ??? todo */ + HashList *vars; /* HTTP variable substitutions for this page */ + StrBuf *trailing_javascript; /* extra javascript to be appended to page */ + char ImportantMessage[SIZ]; StrBuf *ImportantMsg; - HashList *Directory; /**< Parts of the directory URL in snippets */ + HashList *Directory; /* Parts of the directory URL in snippets */ + const Floor *CurrentFloor; /**< when Parsing REST, which floor are we on? */ /* accounting */ - StrBuf *wc_username; /**< login name of current user */ - StrBuf *wc_fullname; /**< Screen name of current user */ - StrBuf *wc_password; /**< Password of current user */ - 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. */ - int need_vali; /**< New users require validation. */ + StrBuf *wc_username; /* login name of current user */ + StrBuf *wc_fullname; /* Screen name of current user */ + StrBuf *wc_password; /* Password of current user */ + StrBuf *httpauth_pass; /* only for GroupDAV sessions */ + int axlevel; /* this user's access level */ + int is_aide; /* nonzero == this user is an Aide */ + int connected; /* nonzero == we are connected to Citadel */ + int logged_in; /* nonzero == we are logged in */ + int need_regi; /* This user needs to register. */ + int need_vali; /* New users require validation. */ /* 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? */ - int SavePrefsToServer; /**< Should we save our preferences to the server at the end of the request? */ - 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 */ - + StrBuf *cs_inet_email; /* User's preferred Internet addr. */ + HashList *hash_prefs; /* WebCit preferences for this user */ + StrBuf *DefaultCharset; /* Charset the user preferes */ + int downloaded_prefs; /* Has the client download its prefs yet? */ + int SavePrefsToServer; /* Should we save our preferences to the server at the end of the request? */ + int selected_language; /* Language selected by user */ + int time_format_cache; /* which timeformat does our user like? */ + + folder CurRoom; /* information about our current room */ + const folder *ThisRoom; /* if REST found a room, remember it here. */ /* next/previous room thingabob */ - struct march *march; /**< march mode room list */ - char ugname[128]; /**< where does 'ungoto' take us */ - long uglsn; /**< last seen message number for ungoto */ + struct march *march; /* march mode room list */ + char ugname[128]; /* where does 'ungoto' take us */ + long uglsn; /* last seen message number for ungoto */ /* Uploading; mime attachments for composing messages */ - 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 */ - char upload_content_type[256]; /**< content type of http-uploaded data */ + HashList *attachments; /* list of attachments for 'enter message' */ + int upload_length; /* content length of http-uploaded data */ + StrBuf *upload; /* pointer to 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 */ + int new_mail; /* user has new mail waiting */ + int remember_new_mail; /* last count of new mail messages */ /* Roomiew control */ - HashList *Floors; /**< floors our citserver has... */ - HashList *summ; /**< list of messages for mailbox summary view */ + HashList *Floors; /* floors our citserver has hashed numeric for quicker access*/ + HashList *FloorsByName; /* same but hashed by its name */ + HashList *Rooms; /* our directory structure as loaded by LKRA */ + HashList *summ; /* list of messages for mailbox summary view */ /** Perhaps these should be within a struct instead */ - long startmsg; /**< message number to start at */ - long maxmsgs; /**< maximum messages to display */ - long num_displayed; /**< number of messages actually displayed */ - HashList *disp_cal_items; /**< sorted list of calendar items; startdate is the sort criteria. */ + long startmsg; /* message number to start at */ + long maxmsgs; /* maximum messages to display */ + long num_displayed; /* number of messages actually displayed */ + HashList *disp_cal_items; /* sorted list of calendar items; startdate is the sort criteria. */ - char last_chat_user[256]; /**< ??? todo */ + char last_chat_user[256]; /* Iconbar controls */ - struct __ofolder *cache_fold; /**< cache the iconbar room list */ - int cache_max_folders; /**< ??? todo */ - int cache_num_floors; /**< ??? todo */ - time_t cache_timestamp; /**< ??? todo */ - HashList *IconBarSettings; /**< which icons should be shown / not shown? */ - const StrBuf *floordiv_expanded; /**< which floordiv currently expanded */ + 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 */ /* cache stuff for templates. TODO: find a smartrer way */ - HashList *ServCfg; /**< cache our server config for editing */ - HashList *InetCfg; /**< Our inet server config for editing */ - + HashList *ServCfg; /* cache our server config for editing */ + HashList *InetCfg; /* Our inet server config for editing */ + ExpirePolicy Policy[maxpolicy]; }; @@ -535,8 +584,8 @@ void RegisterHeaderHandler(const char *Name, long Len, Header_Evaluator F); enum { - S_SELECT, S_SHUTDOWN, + S_SPAWNER, MAX_SEMAPHORES }; @@ -568,18 +617,15 @@ extern int is_https; extern int setup_wizard; extern char wizard_filename[]; extern int follow_xff; +extern int num_threads_existing; +extern int num_threads_executing; void InitialiseSemaphores(void); void begin_critical_section(int which_one); void end_critical_section(int which_one); -void stuff_to_cookie(char *cookie, size_t clen, - int session, - StrBuf *user, - StrBuf *pass, - StrBuf *room, - const char *language -); +void stuff_to_cookie(int unset_cookie); + void cookie_to_stuff(StrBuf *cookie, int *session, StrBuf *user, @@ -590,7 +636,7 @@ void cookie_to_stuff(StrBuf *cookie, void locate_host(StrBuf *TBuf, int); void become_logged_in(const StrBuf *user, const StrBuf *pass, StrBuf *serv_response); void openid_manual_create(void); -void display_login(); +void display_login(void); void display_openids(void); void do_welcome(void); void do_logout(void); @@ -599,10 +645,12 @@ 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); +void CreateMimeStr(void); int GetConnected(void); void DeleteServInfo(ServInfo **FreeMe); int uds_connectsock(char *); -int tcp_connectsock(char *, char *); +int tcp_connectsock(char *, int); int serv_getln(char *strbuf, int bufsize); int StrBuf_ServGetln(StrBuf *buf); int GetServerStatus(StrBuf *Line, long* FullState); @@ -633,7 +681,14 @@ void output_headers( int do_httpheaders, int suppress_check, int cache); void output_custom_content_header(const char *ctype); -void wprintf(const char *format,...)__attribute__((__format__(__printf__,1,2))); + +#ifdef UBER_VERBOSE_DEBUGGING +#define wc_printf(...) wcc_printf(__FILE__, __FUNCTION__, __LINE__, __VA_ARGS__) +void wcc_printf(const char *FILE, const char *FUNCTION, long LINE, const char *format, ...); +#else +void wc_printf(const char *format,...)__attribute__((__format__(__printf__,1,2))); +#endif + void hprintf(const char *format,...)__attribute__((__format__(__printf__,1,2))); void output_static(const char* What); @@ -650,7 +705,7 @@ 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, StrBuf *vcard_source, char alpha, int full, char **storename, long msgnum); +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); @@ -694,8 +749,6 @@ void clear_local_substs(void); int lingering_close(int fd); -char *memreadline(char *start, char *buf, int maxlen); -char *memreadlinelen(char *start, char *buf, int maxlen, int *retlen); long extract_token(char *dest, const char *source, int parmnum, char separator, int maxlen); void remove_token(char *source, int parmnum, char separator); StrBuf *load_mimepart(long msgnum, char *partnum); @@ -714,7 +767,6 @@ void folders(void); -void display_addressbook(long msgnum, char alpha); void offer_start_page(StrBuf *Target, WCTemplputParams *TP); void convenience_page(const char *titlebarcolor, const char *titlebarmsg, const char *messagetext); void output_html(const char *, int, int, StrBuf *, StrBuf *); @@ -758,17 +810,17 @@ int ical_ctdl_is_overlap( extern char *months[]; extern char *days[]; -int read_server_binary(StrBuf *Ret, size_t total_len, StrBuf *Buf); +int serv_read_binary(StrBuf *Ret, size_t total_len, StrBuf *Buf); int StrBuf_ServGetBLOB(StrBuf *buf, long BlobSize); int StrBuf_ServGetBLOBBuffered(StrBuf *buf, long BlobSize); int read_server_text(StrBuf *Buf, long *nLines); -int goto_config_room(StrBuf *Buf); long locate_user_vcard_in_this_room(message_summary **VCMsg, wc_mime_attachment **VCAtt); 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); @@ -779,8 +831,8 @@ void end_tab(int tabnum, int num_tabs); void str_wiki_index(char *s); long guess_calhourformat(void); int get_time_format_cached (void); -int xtoi(const char *in, size_t len); const char *get_selected_language(void); +void display_wiki_pagelist(void); #define DATEFMT_FULL 0 #define DATEFMT_BRIEF 1 @@ -846,3 +898,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 */