/*
* $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.
+ * \ingroup CitadelCommunitacion
*/
+/*@{*/
#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,
);
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.
*/
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')
-/*
- * Read Citadel variformat text and spit it out as HTML.
+/**
+ * \brief Read Citadel variformat text and spit it out as HTML.
+ * \param align html align string
*/
void fmout(char *align)
{
}
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.
*/
if ((bq == 1) && (!strncmp(buf, " >", 2))) {
strcpy(buf, &buf[2]);
}
- /* Activate embedded URL's */
+ /** Activate embedded URL's */
url(buf);
escputs(buf);
-/*
- * Read Citadel variformat text and spit it out as HTML in a form
+/**
+ * \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!)
*/
}
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.
*/
-/*
- * 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.
+/**
+ * \brief Transmit message text (in memory) to the server.
+ *
+ * \param ptr Pointer to the message being transmitted
*/
-void text_to_server(char *ptr, int convert_to_html)
+void text_to_server(char *ptr)
{
- char buf[SIZ];
- char conv[4];
+ char buf[256];
int ch, a, pos;
pos = 0;
buf[strlen(buf) - 1] = 0;
serv_puts(buf);
buf[0] = 0;
- if (convert_to_html) {
- strcat(buf, "<br />");
- }
- else {
- if (ptr[pos] != 0) strcat(buf, " ");
- }
- } else if ((convert_to_html)&&(strchr("#&;`'|*?-~<>^()[]{}$\\", ch) != NULL)) {
- sprintf(conv, "%c", ch);
- stresc(&buf[strlen(buf)], conv, 0, 0);
+ if (ptr[pos] != 0) strcat(buf, " ");
} else {
a = strlen(buf);
buf[a + 1] = 0;
}
}
serv_puts(buf);
-
}
-/*
- * 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()
-/*
+/**
* 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];
}
-/*
- * 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.
*/
return(text);
}
+
+
+
+/*@}*/