source: protocols/oscar/msgcookie.c @ 4466e3e

Last change on this file since 4466e3e was e88fe7da, checked in by Veres Lajos <vlajos@…>, at 2015-08-07T21:53:25Z

typofix - https://github.com/vlajos/misspell_fixer

  • Property mode set to 100644
File size: 4.1 KB
Line 
1/*
2 * Cookie Caching stuff. Adam wrote this, apparently just some
3 * derivatives of n's SNAC work. I cleaned it up, added comments.
4 *
5 */
6
7/*
8 * I'm assuming that cookies are type-specific. that is, we can have
9 * "1234578" for type 1 and type 2 concurrently. if i'm wrong, then we
10 * lose some error checking. if we assume cookies are not type-specific and are
11 * wrong, we get quirky behavior when cookies step on each others' toes.
12 */
13
14#include <aim.h>
15#include "info.h"
16
17/**
18 * aim_cachecookie - appends a cookie to the cookie list
19 * @sess: session to add to
20 * @cookie: pointer to struct to append
21 *
22 * if cookie->cookie for type cookie->type is found, updates the
23 * ->addtime of the found structure; otherwise adds the given cookie
24 * to the cache
25 *
26 * returns -1 on error, 0 on append, 1 on update.  the cookie you pass
27 * in may be free'd, so don't count on its value after calling this!
28 *
29 */
30int aim_cachecookie(aim_session_t *sess, aim_msgcookie_t *cookie)
31{
32        aim_msgcookie_t *newcook;
33
34        if (!sess || !cookie) {
35                return -EINVAL;
36        }
37
38        newcook = aim_checkcookie(sess, cookie->cookie, cookie->type);
39
40        if (newcook == cookie) {
41                newcook->addtime = time(NULL);
42                return 1;
43        } else if (newcook) {
44                aim_cookie_free(sess, newcook);
45        }
46
47        cookie->addtime = time(NULL);
48
49        cookie->next = sess->msgcookies;
50        sess->msgcookies = cookie;
51
52        return 0;
53}
54
55/**
56 * aim_uncachecookie - grabs a cookie from the cookie cache (removes it from the list)
57 * @sess: session to grab cookie from
58 * @cookie: cookie string to look for
59 * @type: cookie type to look for
60 *
61 * 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.
62 *
63 * if found, returns the struct; if none found (or on error), returns NULL:
64 */
65aim_msgcookie_t *aim_uncachecookie(aim_session_t *sess, guint8 *cookie, int type)
66{
67        aim_msgcookie_t *cur, **prev;
68
69        if (!cookie || !sess->msgcookies) {
70                return NULL;
71        }
72
73        for (prev = &sess->msgcookies; (cur = *prev); ) {
74                if ((cur->type == type) &&
75                    (memcmp(cur->cookie, cookie, 8) == 0)) {
76                        *prev = cur->next;
77                        return cur;
78                }
79                prev = &cur->next;
80        }
81
82        return NULL;
83}
84
85/**
86 * aim_mkcookie - generate an aim_msgcookie_t *struct from a cookie string, a type, and a data pointer.
87 * @c: pointer to the cookie string array
88 * @type: cookie type to use
89 * @data: data to be cached with the cookie
90 *
91 * returns NULL on error, a pointer to the newly-allocated cookie on
92 * success.
93 *
94 */
95aim_msgcookie_t *aim_mkcookie(guint8 *c, int type, void *data)
96{
97        aim_msgcookie_t *cookie;
98
99        if (!c) {
100                return NULL;
101        }
102
103        if (!(cookie = g_new0(aim_msgcookie_t, 1))) {
104                return NULL;
105        }
106
107        cookie->data = data;
108        cookie->type = type;
109        memcpy(cookie->cookie, c, 8);
110
111        return cookie;
112}
113
114/**
115 * aim_checkcookie - check to see if a cookietuple has been cached
116 * @sess: session to check for the cookie in
117 * @cookie: pointer to the cookie string array
118 * @type: type of the cookie to look for
119 *
120 * this returns a pointer to the cookie struct (still in the list) on
121 * success; returns NULL on error/not found
122 *
123 */
124
125aim_msgcookie_t *aim_checkcookie(aim_session_t *sess, const guint8 *cookie, int type)
126{
127        aim_msgcookie_t *cur;
128
129        for (cur = sess->msgcookies; cur; cur = cur->next) {
130                if ((cur->type == type) &&
131                    (memcmp(cur->cookie, cookie, 8) == 0)) {
132                        return cur;
133                }
134        }
135
136        return NULL;
137}
138
139/**
140 * aim_cookie_free - free an aim_msgcookie_t struct
141 * @sess: session to remove the cookie from
142 * @cookiep: the address of a pointer to the cookie struct to remove
143 *
144 * this function removes the cookie *cookie from the list of cookies
145 * in sess, and then frees all memory associated with it. including
146 * its data! if you want to use the private data after calling this,
147 * make sure you copy it first.
148 *
149 * returns -1 on error, 0 on success.
150 *
151 */
152int aim_cookie_free(aim_session_t *sess, aim_msgcookie_t *cookie)
153{
154        aim_msgcookie_t *cur, **prev;
155
156        if (!sess || !cookie) {
157                return -EINVAL;
158        }
159
160        for (prev = &sess->msgcookies; (cur = *prev); ) {
161                if (cur == cookie) {
162                        *prev = cur->next;
163                } else {
164                        prev = &cur->next;
165                }
166        }
167
168        g_free(cookie->data);
169        g_free(cookie);
170
171        return 0;
172}
Note: See TracBrowser for help on using the repository browser.