Cleaned up some of the comments ... removed vestiges of last year's doxygen experiment
[citadel.git] / webcit / serv_func.c
index 652ab857940e3fb07cb9720f2457204daec0133c..29b0481760d082ffbeb76707b7e866d2e2c37613 100644 (file)
@@ -1,44 +1,24 @@
 /*
- * serv_func.c
- *
- * Handles various types of data transfer operations with the Citadel service.
- *
  * $Id$
  */
 
-#include <ctype.h>
-#include <stdlib.h>
-#include <unistd.h>
-#include <stdio.h>
-#include <fcntl.h>
-#include <signal.h>
-#include <sys/types.h>
-#include <sys/wait.h>
-#include <sys/socket.h>
-#include <sys/time.h>
-#include <limits.h>
-#include <netinet/in.h>
-#include <netdb.h>
-#include <string.h>
-#include <pwd.h>
-#include <errno.h>
-#include <stdarg.h>
-#include <pthread.h>
-#include <signal.h>
 #include "webcit.h"
 #include "webserver.h"
 
-struct serv_info serv_info;
-
+struct serv_info serv_info; /**< our connection data to the server */
+HashList *ServHash = NULL;//// TODO;
 /*
  * get info about the server we've connected to
+ *
+ * browser_host                the citadell we want to connect to
+ * user_agent          which browser uses our client?
  */
 void get_serv_info(char *browser_host, char *user_agent)
 {
        char buf[SIZ];
        int a;
 
-       /* Tell the server what kind of client is connecting */
+       /** Tell the server what kind of client is connecting */
        serv_printf("IDEN %d|%d|%d|%s|%s",
                DEVELOPER_ID,
                CLIENT_ID,
@@ -46,47 +26,77 @@ void get_serv_info(char *browser_host, char *user_agent)
                user_agent,
                browser_host
        );
-       serv_gets(buf);
+       serv_getln(buf, sizeof buf);
 
-       /* Tell the server what kind of richtext we prefer */
+       /** Tell the server what kind of richtext we prefer */
        serv_puts("MSGP text/html|text/plain");
-       serv_gets(buf);
+       serv_getln(buf, sizeof buf);
+
+       /*
+        * 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");
+       serv_getln(buf, sizeof buf);
 
-       /* 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");
-       serv_gets(buf);
+       serv_getln(buf, sizeof buf);
        if (buf[0] != '1')
                return;
 
        a = 0;
-       while (serv_gets(buf), strcmp(buf, "000")) {
+       while (serv_getln(buf, sizeof buf), strcmp(buf, "000")) {
                switch (a) {
                case 0:
                        serv_info.serv_pid = atoi(buf);
+                       WC->ctdl_pid = serv_info.serv_pid;
                        break;
                case 1:
-                       strcpy(serv_info.serv_nodename, buf);
+                       safestrncpy(serv_info.serv_nodename, buf, sizeof serv_info.serv_nodename);
                        break;
                case 2:
-                       strcpy(serv_info.serv_humannode, buf);
+                       safestrncpy(serv_info.serv_humannode, buf, sizeof serv_info.serv_humannode);
                        break;
                case 3:
-                       strcpy(serv_info.serv_fqdn, buf);
+                       safestrncpy(serv_info.serv_fqdn, buf, sizeof serv_info.serv_fqdn);
                        break;
                case 4:
-                       strcpy(serv_info.serv_software, buf);
+                       safestrncpy(serv_info.serv_software, buf, sizeof serv_info.serv_software);
                        break;
                case 5:
                        serv_info.serv_rev_level = atoi(buf);
                        break;
                case 6:
-                       strcpy(serv_info.serv_bbs_city, buf);
+                       safestrncpy(serv_info.serv_bbs_city, buf, sizeof serv_info.serv_bbs_city);
                        break;
                case 7:
-                       strcpy(serv_info.serv_sysadm, buf);
+                       safestrncpy(serv_info.serv_sysadm, buf, sizeof serv_info.serv_sysadm);
                        break;
                case 9:
-                       strcpy(serv_info.serv_moreprompt, buf);
+                       safestrncpy(serv_info.serv_moreprompt, buf, sizeof serv_info.serv_moreprompt);
+                       break;
+               case 14:
+                       serv_info.serv_supports_ldap = atoi(buf);
+                       break;
+               case 15:
+                       serv_info.serv_newuser_disabled = atoi(buf);
+                       break;
+               case 16:
+                       safestrncpy(serv_info.serv_default_cal_zone, buf, sizeof serv_info.serv_default_cal_zone);
+                       break;
+               case 20:
+                       serv_info.serv_supports_sieve = atoi(buf);
+                       break;
+               case 21:
+                       serv_info.serv_fulltext_enabled = atoi(buf);
+                       break;
+               case 22:
+                       safestrncpy(serv_info.serv_svn_revision, buf, sizeof serv_info.serv_svn_revision);
+                       break;
+               case 23:
+                       serv_info.serv_supports_openid = atoi(buf);
                        break;
                }
                ++a;
@@ -95,93 +105,126 @@ void get_serv_info(char *browser_host, char *user_agent)
 
 
 
-/* 
- * Function to spit out Citadel variformat text in HTML
- * If fp is non-null, it is considered to be the file handle to read the
- * text from.  Otherwise, text is read from the server.
+/**
+ *  Read Citadel variformat text and spit it out as HTML.
+ *  align html align string
  */
-void fmout(FILE * fp)
+inline void fmout(char *align)
 {
+       _fmout(WC->WBuf, align);
+}
 
+void _fmout(StrBuf *Target, char *align)
+{
        int intext = 0;
        int bq = 0;
        char buf[SIZ];
 
-       wprintf("<DIV ALIGN=JUSTIFY>\n");
-       while (1) {
-               if (fp == NULL)
-                       serv_gets(buf);
-               if (fp != NULL) {
-                       if (fgets(buf, SIZ, fp) == NULL)
-                               strcpy(buf, "000");
-                       buf[strlen(buf) - 1] = 0;
-               }
-               if (!strcmp(buf, "000")) {
-                       if (bq == 1)
-                               wprintf("</I>");
-                       wprintf("</DIV><BR>\n");
-                       return;
-               }
+       StrBufAppendPrintf(Target, "<div align=%s>\n", align);
+       while (serv_getln(buf, sizeof buf), strcmp(buf, "000")) {
+
                if ((intext == 1) && (isspace(buf[0]))) {
-                       wprintf("<BR>");
+                       wprintf("<br />");
                }
                intext = 1;
 
-               /* Quoted text should be displayed in italics and in a
-                * different colour.  This code understands both Citadel/UX
-                * style " >" quotes and FordBoard-style " :-)" quotes.
+               /**
+                * 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 ((bq == 0) &&
-                   ((!strncmp(buf, " >", 2)) || (!strncmp(buf, " :-)", 4)))) {
-                       wprintf("<SPAN CLASS=\"pull_quote\">");
+               if ((bq == 0) && (!strncmp(buf, " >", 2))) {
+                       StrBufAppendBufPlain(Target, HKEY("<BLOCKQUOTE>"), 0);
                        bq = 1;
-               } else if ((bq == 1) &&
-                 (strncmp(buf, " >", 2)) && (strncmp(buf, " :-)", 4))) {
-                       wprintf("</SPAN>");
+               } else if ((bq == 1) && (strncmp(buf, " >", 2))) {
+                       StrBufAppendBufPlain(Target, HKEY("</BLOCKQUOTE>"), 0);
                        bq = 0;
                }
-               /* Activate embedded URL's */
-               url(buf);
+               if ((bq == 1) && (!strncmp(buf, " >", 2))) {
+                       strcpy(buf, &buf[2]);
+               }
+               /** Activate embedded URL's */
+               url(buf, sizeof(buf));
 
-               escputs(buf);
-               wprintf("\n");
+               escputs(buf);//// TODO: Target
+               StrBufAppendBufPlain(Target, HKEY("\n"), 0);
+       }
+       if (bq == 1) {
+               wprintf("</I>");
        }
+       wprintf("</div><br />\n");
 }
 
 
 
 
-/*
- * Transmit message text (in memory) to the server.
- * If convert_to_html is set to 1, the message is converted into something
- * which kind of resembles HTML.
+/**
+ *  Read Citadel variformat text and spit it out as HTML in a form
+ * suitable for embedding in another message (forward/quote).
+ * (NO LINEBREAKS ALLOWED HERE!)
  */
-void text_to_server(char *ptr, int convert_to_html)
-{
+void pullquote_fmout(void) {
+       int intext = 0;
+       int bq = 0;
        char buf[SIZ];
-       int ch, a, pos;
 
-       if (convert_to_html) {
-               serv_puts("<HTML><BODY>");
+       while (serv_getln(buf, sizeof buf), strcmp(buf, "000")) {
+
+               if ((intext == 1) && (isspace(buf[0]))) {
+                       wprintf("<br />");
+               }
+               intext = 1;
+
+               /**
+                * 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 ((bq == 0) && (!strncmp(buf, " >", 2))) {
+                       wprintf("<BLOCKQUOTE>");
+                       bq = 1;
+               } else if ((bq == 1) && (strncmp(buf, " >", 2))) {
+                       wprintf("</BLOCKQUOTE>");
+                       bq = 0;
+               }
+               if ((bq == 1) && (!strncmp(buf, " >", 2))) {
+                       strcpy(buf, &buf[2]);
+               }
+
+               msgescputs(buf);
        }
+       if (bq == 1) {
+               wprintf("</I>");
+       }
+}
+
+
+
+
+/**
+ *  Transmit message text (in memory) to the server.
+ *
+ *  ptr Pointer to the message being transmitted
+ */
+void text_to_server(char *ptr)
+{
+       char buf[256];
+       int ch, a, pos, len;
 
        pos = 0;
-       strcpy(buf, "");
+       buf[0] = 0;
 
        while (ptr[pos] != 0) {
                ch = ptr[pos++];
                if (ch == 10) {
-                       while ( (isspace(buf[strlen(buf) - 1]))
-                         && (strlen(buf) > 1) )
-                               buf[strlen(buf) - 1] = 0;
+                       len = strlen(buf);
+                       while ( (isspace(buf[len - 1]))
+                               && (buf[0] !=  '\0') 
+                               && (buf[1] !=  '\0') )
+                               buf[--len] = 0;
                        serv_puts(buf);
-                       strcpy(buf, "");
-                       if (convert_to_html) {
-                               strcat(buf, "<BR>");
-                       }
-                       else {
-                               if (ptr[pos] != 0) strcat(buf, " ");
-                       }
+                       buf[0] = 0;
+                       if (ptr[pos] != 0) strcat(buf, " ");
                } else {
                        a = strlen(buf);
                        buf[a + 1] = 0;
@@ -189,26 +232,96 @@ void text_to_server(char *ptr, int convert_to_html)
                        if ((ch == 32) && (strlen(buf) > 200)) {
                                buf[a] = 0;
                                serv_puts(buf);
-                               strcpy(buf, "");
+                               buf[0] = 0;
                        }
                        if (strlen(buf) > 250) {
                                serv_puts(buf);
-                               strcpy(buf, "");
+                               buf[0] = 0;
                        }
                }
        }
        serv_puts(buf);
+}
+
 
-       if (convert_to_html) {
-               serv_puts("</BODY></HTML>\n");
+/**
+ *  Transmit message text (in memory) to the server,
+ *        converting to Quoted-Printable encoding as we go.
+ *
+ *  ptr Pointer to the message being transmitted
+ */
+void text_to_server_qp(char *ptr)
+{
+       unsigned char ch, buf[256];
+       int pos;
+       int output_len = 0;
+
+       pos = 0;
+       buf[0] = 0;
+       output_len = 0;
+
+       while (ptr[pos] != 0) {
+               ch = (unsigned char)(ptr[pos++]);
+
+               if (ch == 13) {
+                       /* ignore carriage returns */
+               }
+               else if (ch == 10) {
+                       /* hard line break */
+                       if (output_len > 0) {
+                               if (isspace(buf[output_len-1])) {
+                                       sprintf((char *)&buf[output_len-1], "=%02X", buf[output_len-1]);
+                                       output_len += 2;
+                               }
+                       }
+                       buf[output_len++] = 0;
+                       serv_puts((char *)buf);
+                       output_len = 0;
+               }
+               else if (ch == 9) {
+                       buf[output_len++] = ch;
+               }
+               else if ( (ch >= 32) && (ch <= 60) ) {
+                       buf[output_len++] = ch;
+               }
+               else if ( (ch >= 62) && (ch <= 126) ) {
+                       buf[output_len++] = ch;
+               }
+               else {
+                       sprintf((char *)&buf[output_len], "=%02X", ch);
+                       output_len += 3;
+               }
+               
+               if (output_len > 72) {
+                       /* soft line break */
+                       if (isspace(buf[output_len-1])) {
+                               sprintf((char *)&buf[output_len-1], "=%02X", buf[output_len-1]);
+                               output_len += 2;
+                       }
+                       buf[output_len++] = '=';
+                       buf[output_len++] = 0;
+                       serv_puts((char *)buf);
+                       output_len = 0;
+               }
        }
 
+       /* end of data - transmit anything that's left */
+       if (output_len > 0) {
+               if (isspace(buf[output_len-1])) {
+                       sprintf((char *)&buf[output_len-1], "=%02X", buf[output_len-1]);
+                       output_len += 2;
+               }
+               buf[output_len++] = 0;
+               serv_puts((char *)buf);
+               output_len = 0;
+       }
 }
 
 
 
-/*
- * translate server message output to text
+
+/**
+ *  translate server message output to text
  * (used for editing room info files and such)
  */
 void server_to_text()
@@ -217,7 +330,7 @@ void server_to_text()
 
        int count = 0;
 
-       while (serv_gets(buf), strcmp(buf, "000")) {
+       while (serv_getln(buf, sizeof buf), strcmp(buf, "000")) {
                if ((buf[0] == 32) && (count > 0)) {
                        wprintf("\n");
                }
@@ -228,34 +341,87 @@ void server_to_text()
 
 
 
-/*
+/**
  * Read binary data from server into memory using a series of
  * server READ commands.
+ * \return the read content as StrBuf
  */
-void read_server_binary(char *buffer, size_t total_len) {
+int read_server_binary(StrBuf *Ret, size_t total_len) 
+{
        char buf[SIZ];
        size_t bytes = 0;
        size_t thisblock = 0;
+       StrBuf *Buf;
+       
+       Buf = NewStrBuf();
+       if (Ret == NULL)
+           return -1;
 
-       memset(buffer, 0, total_len);
        while (bytes < total_len) {
                thisblock = 4095;
                if ((total_len - bytes) < thisblock) {
                        thisblock = total_len - bytes;
-                       if (thisblock == 0) return;
+                       if (thisblock == 0) {
+                               FlushStrBuf(Ret); 
+                               FreeStrBuf(&Buf);
+                               return -1; 
+                       }
                }
                serv_printf("READ %d|%d", (int)bytes, (int)thisblock);
-               serv_gets(buf);
-               if (buf[0] == '6') {
-                       thisblock = (size_t)atoi(&buf[4]);
-                       serv_read(&buffer[bytes], thisblock);
-                       bytes += thisblock;
+               if (StrBuf_ServGetln(Buf) > 0)
+               {
+                   if (ChrPtr(Buf)[0] == '6')
+                   {
+                           StrBufCutLeft(Buf, 4); //thisblock = (size_t)atoi(&buf[4]);
+                           thisblock = StrTol(Buf);
+                           if (!WC->connected) {
+                                   FlushStrBuf(Ret); 
+                                   FreeStrBuf(&Buf); 
+                                   return -1; 
+                           }
+                           StrBuf_ServGetBLOB(Ret, thisblock);
+                           bytes += thisblock;
+                   }
+                   else {
+                           FreeStrBuf(&Buf);
+                           lprintf(3, "Error: %s\n", &buf[4]);
+                           return -1;
+                   }
                }
-               else {
-                       lprintf(3, "Error: %s\n", &buf[4]);
-                       return;
+       }
+       FreeStrBuf(&Buf);
+       return StrLength(Ret);
+}
+
+
+/**
+ *  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)
+{
+       struct wcsession *WCC = WC;
+       long nRead;
+       long nTotal = 0;
+       long nlines;
+       
+       nlines = 0;
+       while ((WCC->serv_sock!=-1) &&
+              (nRead = StrBuf_ServGetln(Buf), (nRead >= 0) ))
+       {
+               if (strcmp(ChrPtr(Buf) + nTotal, "000") != 0) {
+                       StrBufCutRight(Buf, nRead);
+                       break;
                }
+               nTotal += nRead;
+               nlines ++;
        }
+
+       *nLines = nlines;
+       return nTotal;
 }
 
 
+
+/*@}*/