Removed logging subsystem from webcit. It's all syslog now.
[citadel.git] / webcit / webcit.h
index 730739485da1e416b0b9ba56465dcd1707be212e..53c0157d9215e1a6052652ceb7f5b82868838b2f 100644 (file)
@@ -1,10 +1,9 @@
-/* $Id$
- *
- * Copyright (c) 1987-2010 by the citadel.org team
+/*
+ * Copyright (c) 1987-2011 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
+ * 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.
  *
  * This program is distributed in the hope that it will be useful,
@@ -14,7 +13,7 @@
  *
  * 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
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  */
 
 #include "sysdep.h"
 #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 <stdarg.h>
 #include <pthread.h>
 #include <signal.h>
+#include <syslog.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 +132,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         783             /* This version of WebCit */
-#define MINIMUM_CIT_VERSION    781             /* min required Citadel ver */
-#define        LIBCITADEL_MIN          781             /* 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 +226,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
@@ -261,9 +262,10 @@ extern char *ssl_cipher_list;
 #define NO_SUCH_SYSTEM                         73      
 #define ALREADY_EXISTS                         74      
 #define MESSAGE_NOT_FOUND              75
+
 /*
  * NLI is the string that shows up in a who's online listing for sessions
- * that are active, but for which no user has yet authenticated.
+ * that are active but do not (yet) have a user logged in.
  */
 #define NLI    "(not logged in)"
 
@@ -297,20 +299,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 +435,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;
@@ -454,6 +455,7 @@ typedef struct _ParsedHttpHdrs {
        StrBuf *c_language;
        StrBuf *this_page;                      /* URL of current page */
        StrBuf *PlainArgs; 
+       StrBuf *HostHeader;
 
        HashList *urlstrings;                   /* variables passed to webcit in a URL */
        HashList *HTTPHeaders;                  /* the headers the client sent us */
@@ -474,14 +476,13 @@ struct wcsession {
        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 *ReadBuf;                        /* linebuffered reads 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 */
@@ -489,6 +490,7 @@ struct wcsession {
        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? */
+       StrBuf *PushedDestination;              /* Where to go after login, registration, etc. */
 
 /* Request local Members */
        StrBuf *CLineBuf;                       /* linebuffering client stuff */
@@ -497,12 +499,11 @@ 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;
        HashList *Directory;                    /* Parts of the directory URL in snippets */
-       const Floor *CurrentFloor;              /**< when Parsing REST, which floor are we on? */
+       const Floor *CurrentFloor;              /* when Parsing REST, which floor are we on? */
 
 /* accounting */
        StrBuf *wc_username;                    /* login name of current user */
@@ -556,19 +557,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 */
 };
 
 
@@ -589,11 +593,12 @@ enum {
        MAX_SEMAPHORES
 };
 
-
 #ifndef num_parms
 #define num_parms(source)              num_tokens(source, '|') 
 #endif
 
+#define site_prefix    (WC ? (WC->Hdr->HostHeader) : NULL)
+
 /* Per-session data */
 #define WC ((struct wcsession *)pthread_getspecific(MyConKey))
 extern pthread_key_t MyConKey;
@@ -638,6 +643,7 @@ 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);
@@ -649,7 +655,7 @@ 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);
@@ -664,6 +670,7 @@ void pullquote_fmout(void);
 void wDumpContent(int);
 
 
+void PutRequestLocalMem(void *Data, DeleteHashDataFunc DeleteIt);
 
 void UrlescPutStrBuf(const StrBuf *strbuf);
 void StrEscPuts(const StrBuf *strbuf);
@@ -774,7 +781,6 @@ void CtdlMakeTempFileName(char *, int);
 void address_book_popup(void);
 void begin_ajax_response(void);
 void end_ajax_response(void);
-void burn_folder_cache(time_t age);
 
 void display_edit_task(void);
 void display_edit_event(void);
@@ -817,6 +823,7 @@ 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
@@ -825,13 +832,6 @@ void display_wiki_pagelist(void);
 void webcit_fmt_date(char *buf, size_t siz, time_t thetime, int Format);
 void summary(void);
 
-int is_mobile_ua(char *user_agent);
-
-void embed_room_banner(void);
-HashList *GetFloorListHash(StrBuf *Target, WCTemplputParams *TP);
-HashList *GetRoomListHash(StrBuf *Target, WCTemplputParams *TP);
-int SortRoomsByListOrder(const void *room1, const void *room2);
-
 /* actual supported locales */
 void TmplGettext(StrBuf *Target, WCTemplputParams *TP);
 void offer_languages(StrBuf *Target, int nArgs, WCTemplateToken *Token, void *Context, int ContextType);