* Cookie Caching stuff. Adam wrote this, apparently just some
* derivatives of n's SNAC work. I cleaned it up, added comments.
*
- * I'm going to rewrite this stuff eventually, honest. -jbm
- *
*/
/*
#define FAIM_INTERNAL
#include <aim.h>
-/*
- * aim_cachecookie:
- * appends a cookie to the cookie list for sess.
- * - if cookie->cookie for type cookie->type is found, -1 is returned
- * - copies cookie struct; you need to free() it afterwards;
- * - cookie->data is not copied, but passed along. don't free it.
- * - cookie->type is just passed across.
+/**
+ * aim_cachecookie - appends a cookie to the cookie list
+ * @sess: session to add to
+ * @cookie: pointer to struct to append
+ *
+ * if cookie->cookie for type cookie->type is found, updates the
+ * ->addtime of the found structure; otherwise adds the given cookie
+ * to the cache
+ *
+ * returns -1 on error, 0 on append, 1 on update. the cookie you pass
+ * in may be free'd, so don't count on its value after calling this!
*
- * returns -1 on error, 0 on success.
*/
-faim_internal int aim_cachecookie(struct aim_session_t *sess,
- struct aim_msgcookie_t *cookie)
+faim_internal int aim_cachecookie(aim_session_t *sess, aim_msgcookie_t *cookie)
{
- struct aim_msgcookie_t *newcook;
-
- if (!sess || !cookie)
- return -1;
-
- printf("\t\tCC cache %d %s", cookie->type, cookie->cookie);
- if(cookie->type == AIM_COOKIETYPE_OFTGET) {
- struct aim_filetransfer_priv *priv;
- priv = cookie->data;
- printf("%s\n", priv->sn);
- } else
- printf("\n");
-
- if( (newcook = aim_checkcookie(sess, cookie->cookie, cookie->type)) ) {
- printf("aim_cachecookie: cookie already cached\n");
- return -1;
- }
-
- if (!(newcook = malloc(sizeof(struct aim_msgcookie_t))))
- return -1;
- memcpy(newcook, cookie, sizeof(struct aim_msgcookie_t));
-
- newcook->next = sess->msgcookies;
- sess->msgcookies = newcook;
-
- return 0;
+ aim_msgcookie_t *newcook;
+
+ if (!sess || !cookie)
+ return -EINVAL;
+
+ newcook = aim_checkcookie(sess, cookie->cookie, cookie->type);
+
+ if (newcook == cookie) {
+ newcook->addtime = time(NULL);
+ return 1;
+ } else if (newcook)
+ aim_cookie_free(sess, newcook);
+
+ cookie->addtime = time(NULL);
+
+ cookie->next = sess->msgcookies;
+ sess->msgcookies = cookie;
+
+ return 0;
}
-/*
- * aim_uncachecookie:
- * takes a cookie string and grabs the cookie struct associated with
- * it. removes struct from chain. returns the struct if found, or
- * NULL on not found.
+/**
+ * aim_uncachecookie - grabs a cookie from the cookie cache (removes it from the list)
+ * @sess: session to grab cookie from
+ * @cookie: cookie string to look for
+ * @type: cookie type to look for
+ *
+ * takes a cookie string and a cookie type and finds the cookie struct associated with that duple, removing it from the cookie list ikn the process.
+ *
+ * if found, returns the struct; if none found (or on error), returns NULL:
+ */
+faim_internal aim_msgcookie_t *aim_uncachecookie(aim_session_t *sess, fu8_t *cookie, int type)
+{
+ aim_msgcookie_t *cur, **prev;
+
+ if (!cookie || !sess->msgcookies)
+ return NULL;
+
+ for (prev = &sess->msgcookies; (cur = *prev); ) {
+ if ((cur->type == type) &&
+ (memcmp(cur->cookie, cookie, 8) == 0)) {
+ *prev = cur->next;
+ return cur;
+ }
+ prev = &cur->next;
+ }
+
+ return NULL;
+}
+
+/**
+ * aim_mkcookie - generate an aim_msgcookie_t *struct from a cookie string, a type, and a data pointer.
+ * @c: pointer to the cookie string array
+ * @type: cookie type to use
+ * @data: data to be cached with the cookie
+ *
+ * returns NULL on error, a pointer to the newly-allocated cookie on
+ * success.
+ *
*/
-faim_internal struct aim_msgcookie_t *aim_uncachecookie(struct aim_session_t *sess, unsigned char *cookie, int type)
+faim_internal aim_msgcookie_t *aim_mkcookie(fu8_t *c, int type, void *data)
{
- struct aim_msgcookie_t *cur, **prev;
+ aim_msgcookie_t *cookie;
- if (!cookie || !sess->msgcookies)
- return NULL;
+ if (!c)
+ return NULL;
- printf("\t\tCC uncache %d %s\n", type, cookie);
+ if (!(cookie = calloc(1, sizeof(aim_msgcookie_t))))
+ return NULL;
- for (prev = &sess->msgcookies; (cur = *prev); ) {
- if ((cur->type == type) &&
- (memcmp(cur->cookie, cookie, 8) == 0)) {
- *prev = cur->next;
- return cur;
- }
- prev = &cur->next;
- }
+ cookie->data = data;
+ cookie->type = type;
+ memcpy(cookie->cookie, c, 8);
- return NULL;
+ return cookie;
}
-faim_internal struct aim_msgcookie_t *aim_mkcookie(unsigned char *c, int type, void *data)
+/**
+ * aim_checkcookie - check to see if a cookietuple has been cached
+ * @sess: session to check for the cookie in
+ * @cookie: pointer to the cookie string array
+ * @type: type of the cookie to look for
+ *
+ * this returns a pointer to the cookie struct (still in the list) on
+ * success; returns NULL on error/not found
+ *
+ */
+
+faim_internal aim_msgcookie_t *aim_checkcookie(aim_session_t *sess, const fu8_t *cookie, int type)
{
- struct aim_msgcookie_t *cookie;
-
- if (!c)
- return NULL;
-
- if (!(cookie = calloc(1, sizeof(struct aim_msgcookie_t))))
- return NULL;
-
- cookie->data = data;
- cookie->type = type;
- memcpy(cookie->cookie, c, 8);
-
- return cookie;
+ aim_msgcookie_t *cur;
+
+ for (cur = sess->msgcookies; cur; cur = cur->next) {
+ if ((cur->type == type) &&
+ (memcmp(cur->cookie, cookie, 8) == 0))
+ return cur;
+ }
+
+ return NULL;
}
-
-faim_internal struct aim_msgcookie_t *aim_checkcookie(struct aim_session_t *sess, const unsigned char *cookie, const int type)
+
+#if 0 /* debugging feature */
+faim_internal int aim_dumpcookie(aim_msgcookie_t *cookie)
{
- struct aim_msgcookie_t *cur;
- printf("\t\tCC check %d %s\n", type, cookie);
+ if (!cookie)
+ return -EINVAL;
- for (cur = sess->msgcookies; cur; cur = cur->next) {
- if ((cur->type == type) &&
- (memcmp(cur->cookie, cookie, 8) == 0))
- return cur;
- }
+ printf("\tCookie at %p: %d/%s with %p, next %p\n",
+ cookie, cookie->type, cookie->cookie,
+ cookie->data, cookie->next);
- return NULL;
+ return 0;
}
+#endif
+
+/**
+ * aim_cookie_free - free an aim_msgcookie_t struct
+ * @sess: session to remove the cookie from
+ * @cookiep: the address of a pointer to the cookie struct to remove
+ *
+ * this function removes the cookie *cookie from teh list of cookies
+ * in sess, and then frees all memory associated with it. including
+ * its data! if you want to use the private data after calling this,
+ * make sure you copy it first.
+ *
+ * returns -1 on error, 0 on success.
+ *
+ */
+faim_internal int aim_cookie_free(aim_session_t *sess, aim_msgcookie_t *cookie)
+{
+ aim_msgcookie_t *cur, **prev;
-faim_internal int aim_freecookie(struct aim_session_t *sess, struct aim_msgcookie_t *cookie) {
- struct aim_msgcookie_t *cur, **prev;
-
- if (!sess || !cookie)
- return -1;
+ if (!sess || !cookie)
+ return -EINVAL;
- /*
- * Make sure its not in the list somewhere still.
- *
- * If this actually happens, theres been a major coding failure
- * on my part. However, that does not reduce its occurance likelyhood.
- */
- for (prev = &sess->msgcookies; (cur = *prev); ) {
- if (cur == cookie) {
- *prev = cur->next;
- } else
- prev = &cur->next;
- }
+ for (prev = &sess->msgcookies; (cur = *prev); ) {
+ if (cur == cookie)
+ *prev = cur->next;
+ else
+ prev = &cur->next;
+ }
- free(cookie);
+ free(cookie->data);
+ free(cookie);
- return 0;
+ return 0;
}
-faim_internal int aim_msgcookie_gettype(int reqclass) {
- /* XXX: hokey-assed. needs fixed. */
- switch(reqclass) {
- case AIM_CAPS_BUDDYICON:
- return AIM_COOKIETYPE_OFTICON;
- break;
- case AIM_CAPS_VOICE:
- return AIM_COOKIETYPE_OFTVOICE;
- break;
- case AIM_CAPS_IMIMAGE:
- return AIM_COOKIETYPE_OFTIMAGE;
- break;
- case AIM_CAPS_CHAT:
- return AIM_COOKIETYPE_CHAT;
- break;
- case AIM_CAPS_GETFILE:
- return AIM_COOKIETYPE_OFTGET;
- break;
- case AIM_CAPS_SENDFILE:
- return AIM_COOKIETYPE_OFTSEND;
- break;
- default:
- return AIM_COOKIETYPE_UNKNOWN;
- break;
- }
+/* XXX I hate switch */
+faim_internal int aim_msgcookie_gettype(int reqclass)
+{
+ /* XXX: hokey-assed. needs fixed. */
+ switch(reqclass) {
+ case AIM_CAPS_BUDDYICON: return AIM_COOKIETYPE_OFTICON;
+ case AIM_CAPS_VOICE: return AIM_COOKIETYPE_OFTVOICE;
+ case AIM_CAPS_IMIMAGE: return AIM_COOKIETYPE_OFTIMAGE;
+ case AIM_CAPS_CHAT: return AIM_COOKIETYPE_CHAT;
+ case AIM_CAPS_GETFILE: return AIM_COOKIETYPE_OFTGET;
+ case AIM_CAPS_SENDFILE: return AIM_COOKIETYPE_OFTSEND;
+ default: return AIM_COOKIETYPE_UNKNOWN;
+ }
}
+
+
andersk / libfaim.git / blobdiff