Performed a bunch of markup fixes suggested by validator.w3.org
[citadel.git] / webcit / webcit.h
index 2f1e04873b5a7c616a8933fef35f9d718c6e6725..9900ddb02d37f6a0fd9faafdc93843cf00ecbf55 100644 (file)
@@ -1,8 +1,7 @@
-/* $Id$
- *
+/*
  * Copyright (c) 1987-2010 by the citadel.org team
  *
- * This program is free software; you can redistribute it and/or modify
+ * This program is open source 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.
 #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
 #define HTTP_TRACING 1
  */
 
+#define DO_DBG_QR 0
+#define DBG_QR(x) if(DO_DBG_QR) _DBG_QR(x)
+#define DBG_QR2(x) if(DO_DBG_QR) _DBG_QR2(x)
+
 #ifdef HTTP_TRACING
 #undef HAVE_ZLIB_H
 #undef HAVE_ZLIB
@@ -131,16 +131,16 @@ extern char *ssl_cipher_list;
 
 #define SIZ                    4096            /* generic buffer size */
 
-#define TRACE fprintf(stderr, "Checkpoint: %s, %d\n", __FILE__, __LINE__)
+#define TRACE fprintf(stderr, "\033[7mCheckpoint: %s, %d\033[0m\n", __FILE__, __LINE__)
 
 #define SLEEPING               180             /* TCP connection timeout */
 #define WEBCIT_TIMEOUT         900             /* WebCit session timeout */
 #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         800             /* This version of WebCit */
+#define MINIMUM_CIT_VERSION    800             /* min required Citadel ver */
+#define        LIBCITADEL_MIN          800             /* min required libcitadel ver */
 #define DEFAULT_HOST           "localhost"     /* Default Citadel server */
 #define DEFAULT_PORT           "504"
 #define TARGET                 "webcit01"      /* Target for inline URL's */
@@ -225,7 +225,7 @@ extern char *ssl_cipher_list;
 
 
 
-
+#define SRV_STATUS_MSG(ServerLineBuf) (ChrPtr(ServerLineBuf) + 4), (StrLength(ServerLineBuf) - 4)
 #define MAJORCODE(a) (((int)(a / 100) ) * 100)
 
 #define LISTING_FOLLOWS        100
@@ -297,20 +297,20 @@ struct urlcontent {
 typedef struct _serv_info {
        int serv_pid;                   /* Process ID of the Citadel server */
        StrBuf *serv_nodename;          /* Node name of the Citadel server */
-       StrBuf *serv_humannode;         /* human readable node name of the Citadel server */
-       StrBuf *serv_fqdn;              /* fully quallified Domain Name (such as uncensored.citadel.org) */
-       StrBuf *serv_software;          /* What version does our connected citadel server use */
-       int serv_rev_level;             /* Whats the citadel server revision */
+       StrBuf *serv_humannode;         /* Juman readable node name of the Citadel server */
+       StrBuf *serv_fqdn;              /* Fully qualified Domain Name (such as uncensored.citadel.org) */
+       StrBuf *serv_software;          /* Free form text description of the server software in use */
+       int serv_rev_level;             /* Server version number (times 100) */
        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_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 */
-       int serv_supports_sieve;        /* Does the server support Sieve mail filtering? */
-       int serv_fulltext_enabled;      /* Does the server have the full text index enabled? */
-       StrBuf *serv_svn_revision;      /* SVN revision of the server */
-       int serv_supports_openid;       /* Does the server support authentication via OpenID? */
+       int serv_supports_sieve;        /* Server supports Sieve mail filtering */
+       int serv_fulltext_enabled;      /* Full text index is enabled */
+       StrBuf *serv_svn_revision;      /* svn or git revision of the server */
+       int serv_supports_openid;       /* Server supports authentication via OpenID */
+       int serv_supports_guest;        /* Server supports unauthenticated guest logins */
 } ServInfo;
 
 
@@ -433,7 +433,6 @@ typedef struct _HdrRefs {
        StrBuf *ContentType;
        StrBuf *RawCookie;
        StrBuf *ReqLine;
-       StrBuf *http_host;                      /* HTTP Host: header */
        StrBuf *browser_host;
        StrBuf *browser_language;
        StrBuf *user_agent;
@@ -497,7 +496,6 @@ struct wcsession {
        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;
@@ -511,7 +509,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. */
@@ -540,7 +537,6 @@ struct wcsession {
        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 */
@@ -558,19 +554,22 @@ 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 */
 
-
+/* Transcoding cache buffers; used to avoid to frequent realloc */
+       StrBuf *ConvertBuf1;
+       StrBuf *ConvertBuf2;
 
 /* 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 */
        ExpirePolicy Policy[maxpolicy];
+
+/* used by the blog viewer */
+       int bptlid;                             /* hash of thread currently being rendered */
 };
 
 
@@ -591,7 +590,6 @@ enum {
        MAX_SEMAPHORES
 };
 
-
 #ifndef num_parms
 #define num_parms(source)              num_tokens(source, '|') 
 #endif
@@ -621,6 +619,7 @@ extern char wizard_filename[];
 extern int follow_xff;
 extern int num_threads_existing;
 extern int num_threads_executing;
+extern StrBuf *site_prefix;
 
 void InitialiseSemaphores(void);
 void begin_critical_section(int which_one);
@@ -640,11 +639,11 @@ void become_logged_in(const StrBuf *user, const StrBuf *pass, StrBuf *serv_respo
 void openid_manual_create(void);
 void display_login(void);
 void display_openids(void);
+void display_default_landing_page(void);
 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);
@@ -652,13 +651,13 @@ void CreateMimeStr(void);
 int GetConnected(void);
 void DeleteServInfo(ServInfo **FreeMe);
 int uds_connectsock(char *);
-int tcp_connectsock(char *, int);
+int tcp_connectsock(char *, char *);
 int serv_getln(char *strbuf, int bufsize);
 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);
@@ -667,6 +666,7 @@ void pullquote_fmout(void);
 void wDumpContent(int);
 
 
+void PutRequestLocalMem(void *Data, DeleteHashDataFunc DeleteIt);
 
 void UrlescPutStrBuf(const StrBuf *strbuf);
 void StrEscPuts(const StrBuf *strbuf);
@@ -703,17 +703,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);
@@ -724,15 +721,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 *);
@@ -755,7 +749,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,
@@ -775,9 +768,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);
@@ -787,11 +777,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);
@@ -821,10 +806,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);
@@ -834,28 +819,17 @@ long guess_calhourformat(void);
 int get_time_format_cached (void);
 const char *get_selected_language(void);
 void display_wiki_pagelist(void);
+HashList *GetRoomListHashLKRA(StrBuf *Target, WCTemplputParams *TP);
 
 #define DATEFMT_FULL 0
 #define DATEFMT_BRIEF 1
 #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);
@@ -878,6 +852,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);
@@ -899,3 +875,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 */