final touches on dkim test harness
[citadel.git] / webcit / serv_func.c
index f6642325f27026f73f65a0c802911bbda16e1996..e987c8216714e413f13bddf62429e8eac50713d4 100644 (file)
@@ -1,21 +1,22 @@
+// Functions which handle communication with the Citadel server.
+//
+// Copyright (c) 1996-2024 by the citadel.org team
+//
+// This program is open source software.  You can redistribute it and/or
+// modify it under the terms of the GNU General Public License, version 3.
 
 #include "webcit.h"
-#include "webserver.h"
 
-int is_uds = 0;
-char serv_sock_name[PATH_MAX] = "";
 
 HashList *EmbeddableMimes = NULL;
 StrBuf *EmbeddableMimeStrs = NULL;
 
-
-void SetInlinMimeRenderers(void)
-{
+void SetInlinMimeRenderers(void) {
        StrBuf *Buf;
 
        Buf = NewStrBuf();
 
-       /* Tell the server what kind of richtext we prefer */
+       // Tell the server what kind of richtext we prefer
        serv_putbuf(EmbeddableMimeStrs);
        StrBuf_ServGetln(Buf);
 
@@ -23,10 +24,10 @@ void SetInlinMimeRenderers(void)
 }
 
 
-void DeleteServInfo(ServInfo **FreeMe)
-{
-       if (*FreeMe == NULL)
+void DeleteServInfo(ServInfo **FreeMe) {
+       if (*FreeMe == NULL) {
                return;
+       }
        FreeStrBuf(&(*FreeMe)->serv_nodename);
        FreeStrBuf(&(*FreeMe)->serv_humannode);
        FreeStrBuf(&(*FreeMe)->serv_fqdn);
@@ -39,14 +40,12 @@ void DeleteServInfo(ServInfo **FreeMe)
        *FreeMe = NULL;
 }
 
-/*
- * get info about the server we've connected to
- *
- * browser_host                the citadel we want to connect to
- * user_agent          which browser uses our client?
- */
-ServInfo *get_serv_info(StrBuf *browser_host, StrBuf *user_agent)
-{
+
+// get info about the server we've connected to
+//
+// browser_host                the citadel we want to connect to
+// user_agent          which browser uses our client?
+ServInfo *get_serv_info(StrBuf *browser_host, StrBuf *user_agent) {
        ServInfo *info;
        StrBuf *Buf;
        int a;
@@ -54,37 +53,27 @@ ServInfo *get_serv_info(StrBuf *browser_host, StrBuf *user_agent)
 
        Buf = NewStrBuf();
 
-       /* Tell the server what kind of client is connecting */
-       serv_printf("IDEN %d|%d|%d|%s|%s",
-                   DEVELOPER_ID,
-                   CLIENT_ID,
-                   CLIENT_VERSION,
-                   ChrPtr(user_agent),
-                   ChrPtr(browser_host)
-       );
+       // Tell the server what kind of client is connecting
+       serv_printf("IDEN 0|0|0|%s|%s", ChrPtr(user_agent), ChrPtr(browser_host));
        StrBuf_ServGetln(Buf);
        if (GetServerStatus(Buf, NULL) != 2) {
-               syslog(LOG_WARNING, "get_serv_info(IDEN): unexpected answer [%s]\n",
-                       ChrPtr(Buf));
+               syslog(LOG_WARNING, "get_serv_info(IDEN): unexpected answer [%s]\n", ChrPtr(Buf));
                FreeStrBuf(&Buf);
                return NULL;
        }
 
-       /*
-        * Tell the server that when we save a calendar event, we
-        * want invitations to be generated by the Citadel server
-        * instead of by the client.
-        */
+       // Tell the server that when we save a calendar event, we
+       // want invitations to be generated by the Citadel server
+       // instead of by the client.
        serv_puts("ICAL sgi|1");
        StrBuf_ServGetln(Buf);
        if (GetServerStatus(Buf, NULL) != 2) {
-               syslog(LOG_WARNING, "get_serv_info(ICAL sgi|1): unexpected answer [%s]\n",
-                       ChrPtr(Buf));
+               syslog(LOG_WARNING, "get_serv_info(ICAL sgi|1): unexpected answer [%s]\n", ChrPtr(Buf));
                FreeStrBuf(&Buf);
                return NULL;
        }
 
-       /* Now ask the server to tell us a little bit about itself... */
+       // Now ask the server to tell us a little bit about itself...
        serv_puts("INFO");
        StrBuf_ServGetln(Buf);
        if (GetServerStatus(Buf, NULL) != 1) {
@@ -159,33 +148,34 @@ ServInfo *get_serv_info(StrBuf *browser_host, StrBuf *user_agent)
        return info;
 }
 
-int GetConnected (void)
-{
+int GetConnected (void) {
        StrBuf *Buf;
-       wcsession *WCC = WC;
-
-       if (WCC->ReadBuf == NULL)
-               WCC->ReadBuf = NewStrBufPlain(NULL, SIZ * 4);
-       if (is_uds) /* unix domain socket */
-               WCC->serv_sock = uds_connectsock(serv_sock_name);
-       else        /* tcp socket */
-               WCC->serv_sock = tcp_connectsock(ctdlhost, ctdlport);
+
+       if (WC->ReadBuf == NULL) {
+               WC->ReadBuf = NewStrBufPlain(NULL, SIZ * 4);
+       }
+
+       static char serv_sock_name[PATH_MAX] = "";
+       if (IsEmptyStr(serv_sock_name)) {
+               snprintf(serv_sock_name, sizeof serv_sock_name, "%s/citadel.socket", ctdl_dir);
+       }
+       WC->serv_sock = connect_to_citadel(serv_sock_name);
        
-       if (WCC->serv_sock < 0) {
-               WCC->connected = 0;
-               FreeStrBuf(&WCC->ReadBuf);
+       if (WC->serv_sock < 0) {
+               WC->connected = 0;
+               FreeStrBuf(&WC->ReadBuf);
                return 1;
        }
        else {
                long Status;
                int short_status;
                Buf = NewStrBuf();
-               WCC->connected = 1;
-               StrBuf_ServGetln(Buf);  /* get the server greeting */
+               WC->connected = 1;
+               StrBuf_ServGetln(Buf);  // get the server greeting
                short_status = GetServerStatus(Buf, &Status);
                FreeStrBuf(&Buf);
 
-               /* Server isn't ready for us? */
+               // Server isn't ready for us?
                if (short_status != 2) {
                        if (Status == 551) {
                                hprintf("HTTP/1.1 503 Service Unavailable\r\n");
@@ -205,24 +195,22 @@ int GetConnected (void)
                        return 1;
                }
 
-               /*
-                * From what host is our user connecting?  Go with
-                * the host at the other end of the HTTP socket,
-                * unless we are following X-Forwarded-For: headers
-                * and such a header has already turned up something.
-                */
-               if ( (!follow_xff) || (StrLength(WCC->Hdr->HR.browser_host) == 0) ) {
-                       if (WCC->Hdr->HR.browser_host == NULL) {
-                               WCC->Hdr->HR.browser_host = NewStrBuf();
-                               Put(WCC->Hdr->HTTPHeaders, HKEY("FreeMeWithTheOtherHeaders"), 
-                                   WCC->Hdr->HR.browser_host, HFreeStrBuf);
+               // From what host is our user connecting?  Go with
+               // the host at the other end of the HTTP socket,
+               // unless we are following X-Forwarded-For: headers
+               // and such a header has already turned up something.
+               if ( (!follow_xff) || (StrLength(WC->Hdr->HR.browser_host) == 0) ) {
+                       if (WC->Hdr->HR.browser_host == NULL) {
+                               WC->Hdr->HR.browser_host = NewStrBuf();
+                               Put(WC->Hdr->HTTPHeaders, HKEY("FreeMeWithTheOtherHeaders"), 
+                                   WC->Hdr->HR.browser_host, HFreeStrBuf);
                        }
-                       locate_host(WCC->Hdr->HR.browser_host, WCC->Hdr->http_sock);
+                       locate_host(WC->Hdr->HR.browser_host, WC->Hdr->http_sock);
                }
-               if (WCC->serv_info == NULL) {
-                       WCC->serv_info = get_serv_info(WCC->Hdr->HR.browser_host, WCC->Hdr->HR.user_agent);
+               if (WC->serv_info == NULL) {
+                       WC->serv_info = get_serv_info(WC->Hdr->HR.browser_host, WC->Hdr->HR.user_agent);
                }
-               if (WCC->serv_info == NULL){
+               if (WC->serv_info == NULL){
                        begin_burst();
                        wc_printf(_("Received unexpected answer from Citadel server; bailing out."));
                        hprintf("HTTP/1.1 502 Bad Gateway\r\n");
@@ -231,17 +219,17 @@ int GetConnected (void)
                        end_webcit_session();
                        return 1;
                }
-               if (WCC->serv_info->serv_rev_level < MINIMUM_CIT_VERSION) {
+               if (WC->serv_info->serv_rev_level < MINIMUM_CIT_VERSION) {
                        begin_burst();
                        wc_printf(_("You are connected to a Citadel "
                                  "server running Citadel %d.%02d. \n"
                                  "In order to run this version of WebCit "
                                  "you must also have Citadel %d.%02d or"
                                  " newer.\n\n\n"),
-                               WCC->serv_info->serv_rev_level / 100,
-                               WCC->serv_info->serv_rev_level % 100,
-                               MINIMUM_CIT_VERSION / 100,
-                               MINIMUM_CIT_VERSION % 100
+                               WC->serv_info->serv_rev_level,
+                               0,
+                               MINIMUM_CIT_VERSION,
+                               0
                                );
                        hprintf("HTTP/1.1 200 OK\r\n");
                        hprintf("Content-type: text/plain; charset=utf-8\r\n");
@@ -255,8 +243,7 @@ int GetConnected (void)
 }
 
 
-void FmOut(StrBuf *Target, const char *align, const StrBuf *Source)
-{
+void FmOut(StrBuf *Target, const char *align, const StrBuf *Source) {
        const char *ptr, *pte;
        const char *BufPtr = NULL;
        StrBuf *Line = NewStrBufPlain(NULL, SIZ);
@@ -284,21 +271,19 @@ void FmOut(StrBuf *Target, const char *align, const StrBuf *Source)
                                StrBufAppendBufPlain(Target, HKEY("<br>"), 0);
                        }
                        intext = 1;
-                       if (isspace(*ptr)) while ((ptr < pte) &&
-                                                 ((*ptr == '>') ||
-                                                  isspace(*ptr)))
-                                          {
-                                                  if (*ptr == '>')
-                                                          bq++;
-                                                  ptr ++;
-                                                  i++;
-                                          }
-
-                       /*
-                        * Quoted text should be displayed in italics and in a
-                        * different colour.  This code understands Citadel-style
-                        * " >" quotes and will convert to <BLOCKQUOTE> tags.
-                        */
+                       if (isspace(*ptr)) {
+                               while ((ptr < pte) && ((*ptr == '>') || isspace(*ptr))) {
+                                       if (*ptr == '>') {
+                                               bq++;
+                                       }
+                                       ptr ++;
+                                       i++;
+                               }
+                       }
+
+                       // Quoted text should be displayed in italics and in a
+                       // different colour.  This code understands Citadel-style
+                       // " >" quotes and will convert to <BLOCKQUOTE> tags.
                        if (i > 0) StrBufCutLeft(Line, i);
                
 
@@ -311,7 +296,7 @@ void FmOut(StrBuf *Target, const char *align, const StrBuf *Source)
                        if (StrLength(Line) == 0)
                                continue;
 
-                       /* Activate embedded URL's */
+                       // Activate embedded URL's
                        UrlizeText(Line1, Line, Line2);
 
                        StrEscAppend(Target, Line1, NULL, 0, 0);
@@ -331,12 +316,8 @@ void FmOut(StrBuf *Target, const char *align, const StrBuf *Source)
 }
 
 
-
-/*
- *  Transmit message text (in memory) to the server.
- */
-void text_to_server(char *ptr)
-{
+// Transmit message text (in memory) to the server.
+void text_to_server(char *ptr) {
        char buf[256];
        int ch, a, pos, len;
 
@@ -345,7 +326,10 @@ void text_to_server(char *ptr)
 
        while (ptr[pos] != 0) {
                ch = ptr[pos++];
-               if (ch == 10) {
+               if (ch == 13) {
+                       // ignore CR characters
+               }
+               else if (ch == 10) {
                        len = strlen(buf);
                        while ( (isspace(buf[len - 1]))
                                && (buf[0] !=  '\0') 
@@ -373,26 +357,18 @@ void text_to_server(char *ptr)
 }
 
 
-/*
- * Transmit message text (in memory) to the server, converting to Quoted-Printable encoding as we go.
- */
-void text_to_server_qp(const StrBuf *SendMeEncoded)
-{
+// Transmit message text (in memory) to the server, converting to Quoted-Printable encoding as we go.
+void text_to_server_qp(const StrBuf *SendMeEncoded) {
        StrBuf *ServBuf;
 
-       ServBuf = StrBufRFC2047encodeMessage(SendMeEncoded);
+       ServBuf = StrBufQuotedPrintableEncode(SendMeEncoded);
        serv_putbuf(ServBuf);
        FreeStrBuf(&ServBuf);
 }
 
 
-
-
-/*
- * translate server message output to text (used for editing room info files and such)
- */
-void server_to_text()
-{
+// translate server message output to text (used for editing room info files and such)
+void server_to_text() {
        char buf[SIZ];
 
        int count = 0;
@@ -407,16 +383,10 @@ void server_to_text()
 }
 
 
-
-
-/*
- * Read text from server, appending to a string buffer until the
- * usual 000 terminator is found.  Caller is responsible for freeing
- * the returned pointer.
- */
-int read_server_text(StrBuf *Buf, long *nLines)
-{
-       wcsession *WCC = WC;
+// Read text from server, appending to a string buffer until the
+// usual 000 terminator is found.  Caller is responsible for freeing
+// the returned pointer.
+int read_server_text(StrBuf *Buf, long *nLines) {
        StrBuf *ReadBuf;
        long nRead;
        long nTotal = 0;
@@ -424,7 +394,7 @@ int read_server_text(StrBuf *Buf, long *nLines)
        
        nlines = 0;
        ReadBuf = NewStrBuf();
-       while ((WCC->serv_sock!=-1) &&
+       while ((WC->serv_sock!=-1) &&
               (nRead = StrBuf_ServGetln(ReadBuf), (nRead >= 0) &&
                ((nRead != 3)||(strcmp(ChrPtr(ReadBuf), "000") != 0))))
        {
@@ -439,8 +409,7 @@ int read_server_text(StrBuf *Buf, long *nLines)
 }
 
 
-int GetServerStatusMsg(StrBuf *Line, long* FullState, int PutImportantMessage, int MajorOK)
-{
+int GetServerStatusMsg(StrBuf *Line, long* FullState, int PutImportantMessage, int MajorOK) {
        int rc;
        if (FullState != NULL)
                *FullState = StrTol(Line);
@@ -455,110 +424,81 @@ int GetServerStatusMsg(StrBuf *Line, long* FullState, int PutImportantMessage, i
 }
 
 
-void tmplput_serv_ip(StrBuf *Target, WCTemplputParams *TP)
-{
+void tmplput_serv_ip(StrBuf *Target, WCTemplputParams *TP) {
        StrBufAppendPrintf(Target, "%d", WC->ctdl_pid);
 }
 
-void tmplput_serv_admin(StrBuf *Target, WCTemplputParams *TP)
-{
-       wcsession *WCC = WC;
-       if (WCC->serv_info == NULL)
+void tmplput_serv_admin(StrBuf *Target, WCTemplputParams *TP) {
+       if (WC->serv_info == NULL)
                return;
-       StrBufAppendTemplate(Target, TP, WCC->serv_info->serv_sysadm, 0);
+       StrBufAppendTemplate(Target, TP, WC->serv_info->serv_sysadm, 0);
 }
 
-void tmplput_serv_nodename(StrBuf *Target, WCTemplputParams *TP)
-{
-       wcsession *WCC = WC;
-       if (WCC->serv_info == NULL)
+void tmplput_serv_nodename(StrBuf *Target, WCTemplputParams *TP) {
+       if (WC->serv_info == NULL)
                return;
-       StrBufAppendTemplate(Target, TP, WCC->serv_info->serv_nodename, 0);
+       StrBufAppendTemplate(Target, TP, WC->serv_info->serv_nodename, 0);
 }
 
-void tmplput_serv_humannode(StrBuf *Target, WCTemplputParams *TP)
-{
-       wcsession *WCC = WC;
-       if (WCC->serv_info == NULL)
+void tmplput_serv_humannode(StrBuf *Target, WCTemplputParams *TP) {
+       if (WC->serv_info == NULL)
                return;
-       StrBufAppendTemplate(Target, TP, WCC->serv_info->serv_humannode, 0);
+       StrBufAppendTemplate(Target, TP, WC->serv_info->serv_humannode, 0);
 }
 
-void tmplput_serv_fqdn(StrBuf *Target, WCTemplputParams *TP)
-{
-       wcsession *WCC = WC;
-       if (WCC->serv_info == NULL)
+void tmplput_serv_fqdn(StrBuf *Target, WCTemplputParams *TP) {
+       if (WC->serv_info == NULL)
                return;
-       StrBufAppendTemplate(Target, TP, WCC->serv_info->serv_fqdn, 0);
+       StrBufAppendTemplate(Target, TP, WC->serv_info->serv_fqdn, 0);
 }
 
-void tmplput_serv_software(StrBuf *Target, WCTemplputParams *TP)
-{
-       wcsession *WCC = WC;
-       if (WCC->serv_info == NULL)
+void tmplput_serv_software(StrBuf *Target, WCTemplputParams *TP) {
+       if (WC->serv_info == NULL)
                return;
-       StrBufAppendTemplate(Target, TP, WCC->serv_info->serv_software, 0);
+       StrBufAppendTemplate(Target, TP, WC->serv_info->serv_software, 0);
 }
 
-void tmplput_serv_rev_level(StrBuf *Target, WCTemplputParams *TP)
-{
-       wcsession *WCC = WC;
-       if (WCC->serv_info == NULL)
-               return;
-       StrBufAppendPrintf(Target, "%d.%02d",
-                           WCC->serv_info->serv_rev_level / 100,
-                           WCC->serv_info->serv_rev_level % 100);
+void tmplput_serv_rev_level(StrBuf *Target, WCTemplputParams *TP) {
+       if (WC->serv_info == NULL) return;
+       StrBufAppendPrintf(Target, "%d", WC->serv_info->serv_rev_level);
 }
-int conditional_serv_newuser_disabled(StrBuf *Target, WCTemplputParams *TP)
-{
-       wcsession *WCC = WC;
-       if (WCC->serv_info == NULL)
+int conditional_serv_newuser_disabled(StrBuf *Target, WCTemplputParams *TP) {
+       if (WC->serv_info == NULL)
                return 0;
-       return WCC->serv_info->serv_newuser_disabled != 0;
+       return WC->serv_info->serv_newuser_disabled != 0;
 }
 
-int conditional_serv_supports_guest(StrBuf *Target, WCTemplputParams *TP)                                                                                                                                       
-{
-       wcsession *WCC = WC;
-        if (WCC->serv_info == NULL)
+int conditional_serv_supports_guest(StrBuf *Target, WCTemplputParams *TP) {
+        if (WC->serv_info == NULL)
                return 0;
-        return WCC->serv_info->serv_supports_guest != 0;
+        return WC->serv_info->serv_supports_guest != 0;
 }
 
-int conditional_serv_supports_openid(StrBuf *Target, WCTemplputParams *TP)
-{
-       wcsession *WCC = WC;
-       if (WCC->serv_info == NULL)
+int conditional_serv_supports_openid(StrBuf *Target, WCTemplputParams *TP) {
+       if (WC->serv_info == NULL)
                return 0;
-       return WCC->serv_info->serv_supports_openid != 0;
+       return WC->serv_info->serv_supports_openid != 0;
 }
 
-int conditional_serv_fulltext_enabled(StrBuf *Target, WCTemplputParams *TP)
-{
-       wcsession *WCC = WC;
-       if (WCC->serv_info == NULL)
+int conditional_serv_fulltext_enabled(StrBuf *Target, WCTemplputParams *TP) {
+       if (WC->serv_info == NULL)
                return 0;
-       return WCC->serv_info->serv_fulltext_enabled != 0;
+       return WC->serv_info->serv_fulltext_enabled != 0;
 }
 
-int conditional_serv_ldap_enabled(StrBuf *Target, WCTemplputParams *TP)
-{
-       wcsession *WCC = WC;
-       if (WCC->serv_info == NULL)
+int conditional_serv_ldap_enabled(StrBuf *Target, WCTemplputParams *TP) {
+       if (WC->serv_info == NULL)
                return 0;
-       return WCC->serv_info->serv_supports_ldap != 0;
+       return WC->serv_info->serv_supports_ldap != 0;
 }
 
-void tmplput_serv_bbs_city(StrBuf *Target, WCTemplputParams *TP)
-{
-       wcsession *WCC = WC;
-       if (WCC->serv_info == NULL)
+void tmplput_serv_bbs_city(StrBuf *Target, WCTemplputParams *TP) {
+       if (WC->serv_info == NULL)
                return;
        StrBufAppendTemplate(Target, TP, WC->serv_info->serv_bbs_city, 0);
 }
 
-void tmplput_mesg(StrBuf *Target, WCTemplputParams *TP)
-{
+void tmplput_mesg(StrBuf *Target, WCTemplputParams *TP) {
        int n = 0;
        int Done = 0;
        StrBuf *Line;
@@ -591,16 +531,19 @@ void tmplput_mesg(StrBuf *Target, WCTemplputParams *TP)
        FreeStrBuf(&Line);
 }
 
+void tmplput_site_prefix(StrBuf *Target, WCTemplputParams *TP) {
+       if ((WC != NULL) && (WC->Hdr->HostHeader != NULL)) {
+               StrBufAppendTemplate(Target, TP, WC->Hdr->HostHeader, 0);
+       }
+}
 
-void RegisterEmbeddableMimeType(const char *MimeType, long MTLen, int Priority)
-{
+void RegisterEmbeddableMimeType(const char *MimeType, long MTLen, int Priority) {
        StrBuf *MT;
        MT = NewStrBufPlain(MimeType, MTLen);
        Put(EmbeddableMimes, IKEY(Priority), MT, HFreeStrBuf);
 }
 
-void CreateMimeStr(void)
-{
+void CreateMimeStr(void) {
        HashPos  *it;
        void *vMime;
        long len = 0;
@@ -639,10 +582,6 @@ void
 InitModule_SERVFUNC
 (void)
 {
-       is_uds = strcasecmp(ctdlhost, "uds") == 0;
-       if (is_uds)
-               snprintf(serv_sock_name, PATH_MAX, "%s/citadel.socket", ctdlport);
-
        RegisterConditional("COND:SERV:OPENID", 2, conditional_serv_supports_openid, CTX_NONE);
        RegisterConditional("COND:SERV:NEWU", 2, conditional_serv_newuser_disabled, CTX_NONE);
        RegisterConditional("COND:SERV:FULLTEXT_ENABLED", 2, conditional_serv_fulltext_enabled, CTX_NONE);
@@ -652,11 +591,16 @@ InitModule_SERVFUNC
        RegisterNamespace("SERV:NODENAME", 0, 1, tmplput_serv_nodename, NULL, CTX_NONE);
        RegisterNamespace("SERV:HUMANNODE", 0, 1, tmplput_serv_humannode, NULL, CTX_NONE);
        RegisterNamespace("SERV:FQDN", 0, 1, tmplput_serv_fqdn, NULL, CTX_NONE);
+       
        RegisterNamespace("SERV:SOFTWARE", 0, 1, tmplput_serv_software, NULL, CTX_NONE);
        RegisterNamespace("SERV:REV_LEVEL", 0, 0, tmplput_serv_rev_level, NULL, CTX_NONE);
        RegisterNamespace("SERV:BBS_CITY", 0, 1, tmplput_serv_bbs_city, NULL, CTX_NONE);
        RegisterNamespace("SERV:MESG", 1, 2, tmplput_mesg, NULL, CTX_NONE);
        RegisterNamespace("SERV:ADMIN", 0, 1, tmplput_serv_admin, NULL, CTX_NONE);
+
+       RegisterNamespace("SERV:SITE:PREFIX", 0, 1, tmplput_site_prefix, NULL, CTX_NONE);
+
+
 }