]> code.citadel.org Git - citadel.git/blobdiff - webcit/webcit.h
Added some glue code for attachment of an OpenID to
[citadel.git] / webcit / webcit.h
index 35d9087cdd5ab0b5d2afa06bd6af4076440e861e..cacacc181180ad2e9054281a52a2dbd7d2e2d679 100644 (file)
@@ -38,6 +38,8 @@
 #include <signal.h>
 #include <sys/utsname.h>
 
+#include <libcitadel.h>
+
 #ifndef INADDR_NONE
 #define INADDR_NONE 0xffffffff
 #endif
@@ -49,7 +51,9 @@
 #ifdef ENABLE_NLS
 #include <libintl.h>
 #include <locale.h>
+#ifdef HAVE_USELOCALE
 extern locale_t wc_locales[];
+#endif
 #define _(string)      gettext(string)
 #else
 #define _(string)      (string)
@@ -98,7 +102,7 @@ extern locale_t wc_locales[];
 #undef PACKAGE_BUGREPORT
 #include "sysdep.h"
 
-
+////////#include "hash.h"
 
 #ifdef HAVE_OPENSSL
 /* Work around RedHat's b0rken OpenSSL includes */
@@ -120,8 +124,9 @@ extern locale_t wc_locales[];
 #define PORT_NUM               2000            /* port number to listen on */
 #define DEVELOPER_ID           0
 #define CLIENT_ID              4
-#define CLIENT_VERSION         723             /* This version of WebCit */
-#define MINIMUM_CIT_VERSION    723             /* min required Citadel ver. */
+#define CLIENT_VERSION         735             /* This version of WebCit */
+#define MINIMUM_CIT_VERSION    730             /* min required Citadel ver */
+#define        LIBCITADEL_MIN          113             /* min required libcitadel ver */
 #define DEFAULT_HOST           "localhost"     /* Default Citadel server */
 #define DEFAULT_PORT           "504"
 #define LB                     (1)             /* Internal escape chars */
@@ -137,6 +142,13 @@ extern locale_t wc_locales[];
 #define DEFAULT_MAXMSGS                20
 
 
+#ifdef LIBCITADEL_VERSION_NUMBER
+#if LIBCITADEL_VERSION_NUMBER < LIBCITADEL_MIN
+#error libcitadel is too old.  Please upgrade it before continuing.
+#endif
+#endif
+
+
 /*
  * Room flags (from Citadel)
  *
@@ -164,7 +176,9 @@ extern locale_t wc_locales[];
 #define QR2_SYSTEM     1               /**< System room; hide by default       */
 #define QR2_SELFLIST   2               /**< Self-service mailing list mgmt     */
 #define QR2_COLLABDEL  4               /**< Anyone who can post can also delete*/
-#define QR2_SUBJECTREQ   8   /**< Subject strongly recommended */
+#define QR2_SUBJECTREQ  8               /**< Subject strongly recommended */
+#define QR2_SMTP_PUBLIC 16              /* smtp public postable room */
+#define QR2_MODERATED  32              /* Listservice aide has to permit posts  */
 
 /**
  * user/room access
@@ -211,29 +225,33 @@ struct httprequest {
 /**
  * \brief      Linked list of session variables encoded in an x-www-urlencoded content type
  */
+typedef struct urlcontent urlcontent;
 struct urlcontent {
-       struct urlcontent *next;   /**< the next variable in the list */ 
        char url_key[32];          /**< the variable name */
        char *url_data;            /**< its value */
+       size_t url_data_size;      /**< how big is it? */
 };
 
 /**
  * \brief information about us ???
  */ 
 struct serv_info {
-       int serv_pid;                   /**< Process ID of the Citadel server */
-       char serv_nodename[32];         /**< Node name of the Citadel server */
-       char serv_humannode[64];        /**< human readable node name of the Citadel server */
-       char serv_fqdn[64];             /**< fully quallified Domain Name (such as uncensored.citadel.org) */
-       char serv_software[64];         /**< What version does our connected citadel server use */
-       int serv_rev_level;             /**< Whats the citadel server revision */
-       char serv_bbs_city[64];         /**< Geographic location of the Citadel server */
-       char serv_sysadm[64];           /**< Name of system administrator */
-       char serv_moreprompt[256];      /**< 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? */
-       char serv_default_cal_zone[128];/**< Default timezone for unspecified calendar items */
+       int serv_pid;                   /* Process ID of the Citadel server */
+       char serv_nodename[32];         /* Node name of the Citadel server */
+       char serv_humannode[64];        /* human readable node name of the Citadel server */
+       char serv_fqdn[64];             /* fully quallified Domain Name (such as uncensored.citadel.org) */
+       char serv_software[64];         /* What version does our connected citadel server use */
+       int serv_rev_level;             /* Whats the citadel server revision */
+       char serv_bbs_city[64];         /* Geographic location of the Citadel server */
+       char serv_sysadm[64];           /* Name of system administrator */
+       char serv_moreprompt[256];      /* 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? */
+       char serv_default_cal_zone[128];/* 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? */
+       char serv_svn_revision[256];    /* SVN revision of the server */
 };
 
 
@@ -266,13 +284,12 @@ struct roomlisting {
 /**
  * \brief Dynamic content for variable substitution in templates
  */
-struct wcsubst {
-       struct wcsubst *next;       /**< next item in the list */  
+typedef struct _wcsubst {
        int wcs_type;                       /**< which type of ??? */
        char wcs_key[32];                   /**< ??? what?*/
        void *wcs_value;                    /**< ???? what?*/
        void (*wcs_function)(void); /**< funcion hook ???*/
-};
+} wcsubst;
 
 /**
  * \brief Values for wcs_type
@@ -302,7 +319,7 @@ struct message_summary {
        long msgnum;            /**< the message number on the citadel server */
        char from[128];         /**< the author */
        char to[128];           /**< the recipient */
-       char subj[128];         /**< the title / subject */
+       char subj[256];         /**< the title / subject */
        int hasattachments;     /**< does it have atachments? */
        int is_new;         /**< is it yet read? */
 };
@@ -321,6 +338,20 @@ struct folder {
        int num_rooms;  /**< If this is a floor, how many rooms does it have */
 };
 
+typedef struct _disp_cal {                                     
+       icalcomponent *cal;             /**< cal items for display */
+       long cal_msgnum;                /**< cal msgids for display */
+       char *from;                     /**< owner of this component */
+       int unread;                     /**< already seen by the user? */
+
+       time_t event_start;
+       time_t event_end;
+
+       int multi_day_event;
+       int is_repeat;
+} disp_cal;                                            
+
+
 /**
  * \brief One of these is kept for each active Citadel session.
  * HTTP transactions are bound to on e at a time.
@@ -366,19 +397,12 @@ struct wcsession {
        int num_summ;                           /**< number of messages in mailbox summary view */
        struct message_summary *summ;           /**< array of messages for mailbox summary view */
        int is_wap;                             /**< Client is a WAP gateway */
-       struct urlcontent *urlstrings;          /**< variables passed to webcit in a URL */
-       struct wcsubst *vars;                   /**< HTTP variable substitutions for this page */
+       HashList *urlstrings;                   /**< variables passed to webcit in a URL */
+       HashList *vars;                         /**< HTTP variable substitutions for this page */
        char this_page[512];                    /**< URL of current page */
        char http_host[512];                    /**< HTTP Host: header */
-       char *preferences;                      /**< WebCit preferences for this user */
-#ifdef WEBCIT_WITH_CALENDAR_SERVICE            
-       /** \brief ical???? */                          
-       struct disp_cal {                                       
-               icalcomponent *cal;             /**< cal items for display */
-               long cal_msgnum;                /**< cal msgids for display */
-       } *disp_cal;                                            
-       int num_cal;                            /**< number of calendar items for display */
-#endif                                                                                 
+       HashList *hash_prefs;                   /**< WebCit preferences for this user */
+       HashList *disp_cal_items;               /**< sorted list of calendar items; startdate is the sort criteria. */
        struct wc_attachment *first_attachment; /**< linked list of attachments for 'enter message' */
        char last_chat_user[256];               /**< ??? todo */
        char ImportantMessage[SIZ];             /**< ??? todo */
@@ -413,7 +437,9 @@ enum {
        MAX_SEMAPHORES
 };
 
+#ifndef num_parms
 #define num_parms(source)              num_tokens(source, '|') 
+#endif
 
 /* Per-session data */
 #define WC ((struct wcsession *)pthread_getspecific(MyConKey))
@@ -440,6 +466,7 @@ extern int setup_wizard;
 extern char wizard_filename[];
 extern time_t if_modified_since;
 extern int follow_xff;
+extern HashList *HandlerHash;
 void do_setup_wizard(void);
 
 
@@ -448,7 +475,7 @@ void begin_critical_section(int which_one);
 void end_critical_section(int which_one);
 
 
-void stuff_to_cookie(char *cookie, int session,
+void stuff_to_cookie(char *cookie, size_t clen, int session,
                        char *user, char *pass, char *room);
 void cookie_to_stuff(char *cookie, int *session,
                 char *user, size_t user_len,
@@ -457,7 +484,12 @@ void cookie_to_stuff(char *cookie, int *session,
 void locate_host(char *, int);
 void become_logged_in(char *, char *, char *);
 void do_login(void);
+void do_openid_login(void);
+void finalize_openid_login(void);
 void display_login(char *mesg);
+void display_openid_login(char *mesg);
+void display_openids(void);
+void openid_attach(void);
 void do_welcome(void);
 void do_logout(void);
 void display_main_menu(void);
@@ -470,7 +502,7 @@ void ungoto(void);
 void get_serv_info(char *, char *);
 int uds_connectsock(char *);
 int tcp_connectsock(char *, char *);
-void serv_getln(char *strbuf, int bufsize);
+int serv_getln(char *strbuf, int bufsize);
 void serv_puts(char *string);
 void who(void);
 void who_inner_div(void);
@@ -483,10 +515,35 @@ void fmout(char *align);
 void pullquote_fmout(void);
 void wDumpContent(int);
 void serv_printf(const char *format,...);
-char *bstr(char *key);
-void urlesc(char *, char *);
+
+/* TODO: get rid of the non-const-typecast */
+#define bstr(a) (char*) Bstr(a, sizeof(a) - 1)
+const char *BSTR(char *key);
+const char *Bstr(char *key, size_t keylen);
+
+#define xbstr(a, b) (char*) XBstr(a, sizeof(a) - 1, b)
+const char *XBstr(char *key, size_t keylen, size_t *len);
+const char *XBSTR(char *key, size_t *len);
+
+#define lbstr(a) LBstr(a, sizeof(a) - 1)
+long LBstr(char *key, size_t keylen);
+long LBSTR(char *key);
+
+#define ibstr(a) IBstr(a, sizeof(a) - 1)
+int IBstr(char *key, size_t keylen);
+int IBSTR(char *key);
+
+#define havebstr(a) HaveBstr(a, sizeof(a) - 1)
+int HaveBstr(char *key, size_t keylen);
+int HAVEBSTR(char *key);
+
+#define yesbstr(a) YesBstr(a, sizeof(a) - 1)
+int YesBstr(char *key, size_t keylen);
+int YESBSTR(char *key);
+
+
 void urlescputs(char *);
-void jsesc(char *, char *);
+void jsesc(char *, size_t, char *);
 void jsescputs(char *);
 void output_headers(    int do_httpheaders,
                        int do_htmlhead,
@@ -496,21 +553,19 @@ void output_headers(    int do_httpheaders,
                        int cache);
 void wprintf(const char *format,...);
 void output_static(char *what);
+void display_mime_icon(void);
 void print_menu_box(char* Title, char *Class, int nLines, ...);
 long stresc(char *target, long tSize, char *strbuf, int nbsp, int nolinebreaks);
 void escputs(char *strbuf);
-void url(char *buf);
+void url(char *buf, size_t bufsize);
 void escputs1(char *strbuf, int nbsp, int nolinebreaks);
-void msgesc(char *target, char *strbuf);
+void msgesc(char *target, size_t tlen, char *strbuf);
 void msgescputs(char *strbuf);
 void msgescputs1(char *strbuf);
-int extract_int(const char *source, int parmnum);
-long extract_long(const char *source, int parmnum);
 void stripout(char *str, char leftboundary, char rightboundary);
 void dump_vars(void);
 void embed_main_menu(void);
 void serv_read(char *buf, int bytes);
-int haschar(const char *, char);
 void readloop(char *oper);
 void read_message(long msgnum, int printable_view, char *section);
 void embed_message(char *msgnum_as_string);
@@ -582,7 +637,6 @@ void smart_goto(char *);
 void worker_entry(void);
 void session_loop(struct httprequest *);
 size_t wc_strftime(char *s, size_t max, const char *format, const struct tm *tm);
-void fmt_date(char *buf, time_t thetime, int brief);
 void fmt_time(char *buf, time_t thetime);
 void httpdate(char *buf, time_t thetime);
 time_t httpdate_to_timestamp(char *buf);
@@ -593,13 +647,25 @@ void chat_send(void);
 void http_redirect(char *);
 void clear_substs(struct wcsession *wc);
 void clear_local_substs(void);
-void svprintf(char *keyname, int keytype, const char *format,...);
-void svcallback(char *keyname, void (*fcn_ptr)() );
+
+
+typedef void (*var_callback_fptr)();
+
+
+void SVPut(char *keyname, size_t keylen, int keytype, char *Data);
+#define svput(a, b, c) SVPut(a, sizeof(a) - 1, b, c)
+void svprintf(char *keyname, size_t keylen, int keytype, const char *format,...);
+void SVPRINTF(char *keyname, int keytype, const char *format,...);
+void SVCALLBACK(char *keyname, var_callback_fptr fcn_ptr);
+void SVCallback(char *keyname, size_t keylen,  var_callback_fptr fcn_ptr);
+#define svcallback(a, b) SVCallback(a, sizeof(a) - 1, b)
+
 void do_template(void *templatename);
+
+
 int lingering_close(int fd);
 char *memreadline(char *start, char *buf, int maxlen);
 char *memreadlinelen(char *start, char *buf, int maxlen, int *retlen);
-int num_tokens (char *source, char tok);
 long extract_token(char *dest, const char *source, int parmnum, char separator, int maxlen);
 void remove_token(char *source, int parmnum, char separator);
 char *load_mimepart(long msgnum, char *partnum);
@@ -623,7 +689,6 @@ void get_preference(char *key, char *value, size_t value_len);
 void set_preference(char *key, char *value, int save_to_server);
 void knrooms(void);
 int is_msg_in_mset(char *mset, long msgnum);
-char *safestrncpy(char *dest, const char *src, size_t n);
 void display_addressbook(long msgnum, char alpha);
 void offer_start_page(void);
 void convenience_page(char *titlebarcolor, char *titlebarmsg, char *messagetext);
@@ -639,18 +704,16 @@ void summary(void);
 void summary_inner_div(void);
 ssize_t write(int fd, const void *buf, size_t count);
 void cal_process_attachment(char *part_source, long msgnum, char *cal_partnum);
-void display_calendar(long msgnum);
-void display_task(long msgnum);
-void display_note(long msgnum);
+void display_calendar(long msgnum, int unread);
+void display_task(long msgnum, int unread);
+void display_note(long msgnum, int unread);
+void add_new_note(void);
 void updatenote(void);
+void ajax_update_note(void);
 void do_calendar_view(void);
 void do_tasks_view(void);
-void free_calendar_buffer(void);
 void calendar_summary_view(void);
 int load_msg_ptrs(char *servcmd, int with_headers);
-size_t CtdlEncodeBase64(char **dest, const char *source, size_t sourcelen, size_t *destlen, int linebreaks);
-int CtdlDecodeBase64(char *dest, const char *source, size_t length);
-int CtdlDecodeQuotedPrintable(char *decoded, char *encoded, int sourcelen);
 void free_attachments(struct wcsession *sess);
 void free_march_list(struct wcsession *wcf);
 void set_room_policy(void);
@@ -678,21 +741,24 @@ 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(char *viewpref);
 void display_room_directory(void);
+void display_picture(void);
+void display_pictureview(void);
 void download_file(char *);
 void upload_file(void);
 
-#ifdef WEBCIT_WITH_CALENDAR_SERVICE
 void display_edit_task(void);
 void save_task(void);
 void display_edit_event(void);
 void save_event(void);
+icaltimezone *get_default_icaltimezone(void);
 void display_icaltimetype_as_webform(struct icaltimetype *, char *);
 void icaltime_from_webform(struct icaltimetype *result, char *prefix);
 void icaltime_from_webform_dateonly(struct icaltimetype *result, char *prefix);
-void display_edit_individual_event(icalcomponent *supplied_vtodo, long msgnum);
-void save_individual_event(icalcomponent *supplied_vtodo, long msgnum);
+void display_edit_individual_event(icalcomponent *supplied_vtodo, long msgnum, char *from, int unread);
+void save_individual_event(icalcomponent *supplied_vtodo, long msgnum, char *from, int unread);
 void respond_to_request(void);
 void handle_rsvp(void);
 void ical_dezonify(icalcomponent *cal);
@@ -706,7 +772,6 @@ int ical_ctdl_is_overlap(
                         struct icaltimetype t2start,
                         struct icaltimetype t2end
 );
-#endif
 
 #ifdef ENABLE_NLS
 void initialize_locales(void);
@@ -719,9 +784,9 @@ char *read_server_text(void);
 int goto_config_room(void);
 long locate_user_vcard(char *username, long usernum);
 void sleeeeeeeeeep(int);
-void http_transmit_thing(char *thing, size_t length, char *content_type,
+void http_transmit_thing(char *thing, size_t length, const char *content_type,
                         int is_static);
-void unescape_input(char *buf);
+long unescape_input(char *buf);
 void do_iconbar(void);
 void do_iconbar_roomlist(void);
 void do_selected_iconbar(void);
@@ -735,15 +800,18 @@ void offer_languages(void);
 void set_selected_language(char *);
 void go_selected_language(void);
 void stop_selected_language(void);
+void preset_locale(void);
 void httplang_to_locale(char *LocaleString);
 void tabbed_dialog(int num_tabs, char *tabnames[]);
 void begin_tab(int tabnum, int num_tabs);
 void end_tab(int tabnum, int num_tabs);
 void str_wiki_index(char *s);
 void display_wiki_page(void);
-char *bmstrcasestr(char *text, char *pattern);
 int get_time_format_cached (void);
 int xtoi(char *in, size_t len);
+void webcit_fmt_date(char *buf, time_t thetime, int brief);
+int fetch_http(char *url, char *target_buf, int maxbytes);
+
 
 #ifdef HAVE_ICONV
 iconv_t ctdl_iconv_open(const char *tocode, const char *fromcode);
@@ -770,13 +838,11 @@ void client_write_ssl(char *buf, int nbytes);
 
 #ifdef HAVE_ZLIB
 #include <zlib.h>
-int ZEXPORT compress_gzip(Bytef * dest, uLongf * destLen,
+int ZEXPORT compress_gzip(Bytef * dest, size_t * destLen,
                           const Bytef * source, uLong sourceLen, int level);
 #endif
 
-#ifdef HAVE_ICONV
 void utf8ify_rfc822_string(char *buf);
-#endif
 
 void begin_burst(void);
 void end_burst(void);
@@ -786,16 +852,14 @@ extern char *hourname[];  /**< Names of hours (12am, 1am, etc.) */
 void http_datestring(char *buf, size_t n, time_t xtime);
 
 
-/** Views (from citadel.h) */
-#define        VIEW_BBS                0       /**< Traditional Citadel BBS view */
-#define VIEW_MAILBOX           1       /**< Mailbox summary */
-#define VIEW_ADDRESSBOOK       2       /**< Address book view */
-#define VIEW_CALENDAR          3       /**< Calendar view */
-#define VIEW_TASKS             4       /**< Tasks view */
-#define VIEW_NOTES             5       /**<  Notes view */
-#define VIEW_WIKI              6       /**<  Wiki view */
-#define VIEW_CALBRIEF          7       /**< Brief Calendar view */
-#define VIEW_JOURNAL            8       /**< Journal view (not yet implemented in webcit) */
+typedef void (*WebcitHandlerFunc)(void);
+typedef struct  _WebcitHandler{
+       WebcitHandlerFunc F;
+       int IsAjax;
+} WebcitHandler;
+void WebcitAddUrlHandler(const char * UrlString, long UrlSLen, WebcitHandlerFunc F, int IsAjax);
+
+
 
 /* These should be empty, but we have them for testing */
 #define DEFAULT_HTTPAUTH_USER  ""