Done with doxygenizing
[citadel.git] / webcit / serv_func.c
index dca9352bfbfdd70dc97721bbe2dffd7a07e2ebb7..00024976c9d45955be657e5700ebca8c4956604e 100644 (file)
@@ -1,43 +1,28 @@
 /*
  * $Id$
- *
- * Handles various types of data transfer operations with the Citadel service.
+ */
+/**
+ * \defgroup ServFuncs Handles various types of data transfer operations with the Citadel service.
  *
  */
 
-#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 */
 
-/*
- * get info about the server we've connected to
+/**
+ * \brief get info about the server we've connected to
+ * \param browser_host the citadell we want to connect to
+ * \param 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,
@@ -47,12 +32,13 @@ void get_serv_info(char *browser_host, char *user_agent)
        );
        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_getln(buf, sizeof buf);
 
 #ifdef WEBCIT_WITH_CALENDAR_SERVICE
-       /* Tell the server that when we save a calendar event, we
+       /**
+        * 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.
         */
@@ -60,7 +46,7 @@ void get_serv_info(char *browser_host, char *user_agent)
        serv_getln(buf, sizeof buf);
 #endif
 
-       /* 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_getln(buf, sizeof buf);
        if (buf[0] != '1')
@@ -74,28 +60,28 @@ void get_serv_info(char *browser_host, char *user_agent)
                        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);
@@ -107,39 +93,26 @@ 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.
+/**
+ * \brief Read Citadel variformat text and spit it out as HTML.
+ * \param align html align string
  */
-void fmout(FILE *fp, char *align)
+void fmout(char *align)
 {
-
        int intext = 0;
        int bq = 0;
        char buf[SIZ];
 
-       wprintf("<DIV ALIGN=%s>\n", align);
-       while (1) {
-               if (fp == NULL)
-                       serv_getln(buf, sizeof 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;
-               }
+       wprintf("<div align=%s>\n", align);
+       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
+               /**
+                * Quoted text should be displayed in italics and in a
                 * different colour.  This code understands Citadel-style
                 * " >" quotes and will convert to <BLOCKQUOTE> tags.
                 */
@@ -153,20 +126,68 @@ void fmout(FILE *fp, char *align)
                if ((bq == 1) && (!strncmp(buf, " >", 2))) {
                        strcpy(buf, &buf[2]);
                }
-               /* Activate embedded URL's */
+               /** Activate embedded URL's */
                url(buf);
 
                escputs(buf);
                wprintf("\n");
        }
+       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
+/**
+ * \brief 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 pullquote_fmout(void) {
+       int intext = 0;
+       int bq = 0;
+       char buf[SIZ];
+
+       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>");
+       }
+}
+
+
+
+
+/**
+ * \brief Transmit message text (in memory) to the server.
+ * \param ptr the output buffer
+ * \param convert_to_html if set to 1, the message is converted into something
  * which kind of resembles HTML.
  */
 void text_to_server(char *ptr, int convert_to_html)
@@ -176,7 +197,7 @@ void text_to_server(char *ptr, int convert_to_html)
        int ch, a, pos;
 
        pos = 0;
-       strcpy(buf, "");
+       buf[0] = 0;
 
        while (ptr[pos] != 0) {
                ch = ptr[pos++];
@@ -185,7 +206,7 @@ void text_to_server(char *ptr, int convert_to_html)
                          && (strlen(buf) > 1) )
                                buf[strlen(buf) - 1] = 0;
                        serv_puts(buf);
-                       strcpy(buf, "");
+                       buf[0] = 0;
                        if (convert_to_html) {
                                strcat(buf, "<br />");
                        }
@@ -202,11 +223,11 @@ 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;
                        }
                }
        }
@@ -216,8 +237,8 @@ void text_to_server(char *ptr, int convert_to_html)
 
 
 
-/*
- * translate server message output to text
+/**
+ * \brief translate server message output to text
  * (used for editing room info files and such)
  */
 void server_to_text()
@@ -237,9 +258,11 @@ void server_to_text()
 
 
 
-/*
+/**
  * Read binary data from server into memory using a series of
  * server READ commands.
+ * \param buffer the output buffer
+ * \param total_len the maximal length of buffer
  */
 void read_server_binary(char *buffer, size_t total_len) {
        char buf[SIZ];
@@ -269,8 +292,8 @@ void read_server_binary(char *buffer, size_t total_len) {
 }
 
 
-/*
- * Read text from server, appending to a string buffer until the
+/**
+ * \brief Read text from server, appending to a string buffer until the
  * usual 000 terminator is found.  Caller is responsible for freeing
  * the returned pointer.
  */
@@ -285,7 +308,7 @@ char *read_server_text(void) {
        if (text == NULL) {
                return(NULL);
        }
-       strcpy(text, "");
+       text[0] = 0;
        bytes_allocated = SIZ;
 
        while (serv_getln(buf, sizeof buf), strcmp(buf, "000")) {
@@ -305,3 +328,7 @@ char *read_server_text(void) {
 
        return(text);
 }
+
+
+
+/*@}*/