Templatize sieve rules editor; return success/fail state of serverwrite
[citadel.git] / webcit / webcit.h
index 33f87cd8066e4dec58126d7c91cf347fe160ba04..efb7f8242bd8e8b4b9df6c2a51af6bb406fcc7cb 100644 (file)
@@ -1,9 +1,9 @@
 /*
- * 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,
@@ -13,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"
@@ -50,6 +50,7 @@
 #include <stdarg.h>
 #include <pthread.h>
 #include <signal.h>
+#include <syslog.h>
 #include <sys/utsname.h>
 #include <libcitadel.h>
 
 #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
@@ -127,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 syslog(LOG_DEBUG, "\033[3%dmCHECKPOINT: %s:%d\033[0m", ((__LINE__%6)+1), __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 */
@@ -221,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
@@ -257,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)"
 
@@ -449,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 */
@@ -469,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 */
@@ -484,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 */
@@ -496,7 +503,7 @@ struct wcsession {
        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 */
@@ -554,13 +561,23 @@ struct wcsession {
        int cache_num_floors;
        long *IBSettingsVec;                    /* which icons should be shown / not shown? */
        const StrBuf *floordiv_expanded;        /* which floordiv currently expanded */
+       int ib_wholist_expanded;
+       int ib_roomlist_expanded;
 
+/* our known Sieve scripts; loaded by SIEVE:SCRIPTS iterator. */
+       HashList *KnownSieveScripts;
 
+/* 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 */
 };
 
 
@@ -581,11 +598,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;
@@ -611,7 +629,6 @@ 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);
@@ -631,8 +648,10 @@ 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_reg(int during_login);
 void display_main_menu(void);
 void display_aide_menu(void);
 void slrp_highest(void);
@@ -646,8 +665,12 @@ 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);
+int serv_puts(const char *string);
 void who(void);
+void push_destination(void);
+void pop_destination(void);
+void robots_txt(void);
+extern void do_404(void);
 
 void ajax_mini_calendar(void);
 void fmout(char *align);
@@ -657,6 +680,7 @@ void pullquote_fmout(void);
 void wDumpContent(int);
 
 
+void PutRequestLocalMem(void *Data, DeleteHashDataFunc DeleteIt);
 
 void UrlescPutStrBuf(const StrBuf *strbuf);
 void StrEscPuts(const StrBuf *strbuf);
@@ -673,6 +697,7 @@ void output_headers(    int do_httpheaders,
                        int suppress_check,
                        int cache);
 void output_custom_content_header(const char *ctype);
+void cdataout(char *rawdata);
 
 #ifdef UBER_VERBOSE_DEBUGGING
 #define wc_printf(...) wcc_printf(__FILE__, __FUNCTION__, __LINE__, __VA_ARGS__)
@@ -712,11 +737,6 @@ long gotoroom(const StrBuf *gname);
 void remove_march(const StrBuf *aaa);
 void dotskip(void);
 void validate(void);
-void display_graphics_upload(char *, char *, char *);
-void do_graphics_upload(char *upl_cmd);
-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 shutdown_sessions(void);
 void do_housekeeping(void);
 void smart_goto(const StrBuf *);
@@ -787,6 +807,11 @@ int ical_ctdl_is_overlap(
 
 extern char *months[];
 extern char *days[];
+void display_graphics_upload(char *, char *, char *);
+void do_graphics_upload(char *upl_cmd);
+int serv_write(const char *buf, int nbytes);
+int serv_putbuf(const StrBuf *string);
+int serv_printf(const char *format,...)__attribute__((__format__(__printf__,1,2)));
 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);
@@ -809,6 +834,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
@@ -817,8 +843,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);
-
 /* actual supported locales */
 void TmplGettext(StrBuf *Target, WCTemplputParams *TP);
 void offer_languages(StrBuf *Target, int nArgs, WCTemplateToken *Token, void *Context, int ContextType);
@@ -865,3 +889,29 @@ void http_datestring(char *buf, size_t n, time_t xtime);
 #define WC_TIMEFORMAT_24 2
 
 extern int time_to_die;                        /* Nonzero if server is shutting down */
+
+/* a nice consistent place to define how we turn a message id into a thread id hash */
+#define ThreadIdHash(Buf) abs(HashLittle(ChrPtr(Buf), StrLength(Buf)))
+
+/* 
+ * Array type for a blog post.  The first message is the post; the rest are comments
+ */
+struct blogpost {
+       int top_level_id;
+       long *msgs;             /* Array of msgnums for messages we are displaying */
+       int num_msgs;           /* Number of msgnums stored in 'msgs' */
+       int alloc_msgs;         /* Currently allocated size of array */
+};
+
+
+/*
+ * Data which gets returned from a call to blogview_learn_thread_references()
+ */
+struct bltr {
+       int id;
+       int refs;
+};
+
+
+struct bltr blogview_learn_thread_references(long msgnum);
+void tmplput_blog_permalink(StrBuf *Target, WCTemplputParams *TP);