converted comments to get caught by doxygen

[citadel.git] / webcit / cookie_conversion.c

diff --git a/webcit/cookie_conversion.c b/webcit/cookie_conversion.c
index 644dbfc32a3b84259d9c71f7818a689b072346ac..040eee612655f37fcc02d77be2fc1049ffcf041c 100644 (file)
--- a/webcit/cookie_conversion.c
+++ b/webcit/cookie_conversion.c
@@ -1,39 +1,29 @@
 /*
  * $Id$
- *
+ */
+/**
+ * \defgroup CookieConversion Grep Cookies
  * Utility functions which convert the HTTP cookie format we use to and
  * from user/password/room strings.
  *
  */
-
-#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"
 
-#define TRUE  1
-#define FALSE 0
 
-typedef unsigned char byte;          /* Byte type */
+#define TRUE  1    /**< for sure? */
+#define FALSE 0    /**< nope. */
 
-/*
+typedef unsigned char byte;          /**< Byte type */
+
+/**
+ * \brief find cookie
  * Pack all session info into one easy-to-digest cookie. Healthy and delicious!
+ * \param cookie cookie string to create???
+ * \param session the session we want to convert into a cookie
+ * \param user the user to be associated with the cookie
+ * \param pass his passphrase
+ * \param room the room he wants to enter
  */
 void stuff_to_cookie(char *cookie, int session,
                char *user, char *pass, char *room)
@@ -48,6 +38,12 @@ void stuff_to_cookie(char *cookie, int session,
        }
 }
 
+/**
+ * \brief some bytefoo ????
+ * \param in the string to chop
+ * \param len the length of the string
+ * \return the corrosponding integer value
+ */
 int xtoi(char *in, size_t len)
 {
     int val = 0;
@@ -61,10 +57,21 @@ int xtoi(char *in, size_t len)
     return val;
 }
 
-/*
- * Extract all that fun stuff out of the cookie.
+/**
+ * \brief Extract all that fun stuff out of the cookie.
+ * \param cookie the cookie string
+ * \param session the corrosponding session to return
+ * \param user the user string
+ * \param user_len the user stringlength
+ * \param pass the passphrase
+ * \param pass_len length of the passphrase string 
+ * \param room the room he is in
+ * \param room_len the length of the room string
  */
-void cookie_to_stuff(char *cookie, int *session, char *user, char *pass, char *room)
+void cookie_to_stuff(char *cookie, int *session,
+               char *user, size_t user_len,
+               char *pass, size_t pass_len,
+               char *room, size_t room_len)
 {
        char buf[SIZ];
        int i, len;
@@ -79,9 +86,10 @@ void cookie_to_stuff(char *cookie, int *session, char *user, char *pass, char *r
        if (session != NULL)
                *session = extract_int(buf, 0);
        if (user != NULL)
-               extract(user, buf, 1);
+               extract_token(user, buf, 1, '|', user_len);
        if (pass != NULL)
-               extract(pass, buf, 2);
+               extract_token(pass, buf, 2, '|', pass_len);
        if (room != NULL)
-               extract(room, buf, 3);
+               extract_token(room, buf, 3, '|', room_len);
 }
+/*@}*/