cookies.h File Reference

Go to the source code of this file.

Data Structures
struct	_cookie

Macros
#define	MAX_HTTP_DATE_LENGTH   128

Typedefs
typedef struct _cookie	Cookie

Functions
Cookie *	cookie_create (void)
void	cookies_destroy (List *)
int	get_cookies (List *, const WSPMachine *)
int	set_cookies (List *, WSPMachine *)

Macro Definition Documentation

MAX_HTTP_DATE_LENGTH

#define MAX_HTTP_DATE_LENGTH   128

Definition at line 106 of file cookies.h.

Referenced by parse_http_date().

Typedef Documentation

Cookie

typedef struct _cookie Cookie

Function Documentation

cookie_create()

Cookie* cookie_create

(

void

)

Definition at line 88 of file cookies.c.

References emptyCookie.

Referenced by parse_cookie().

{
    Cookie *p;

    p = gw_malloc(sizeof(Cookie));  /* Never returns NULL */

    *p = emptyCookie;
    p -> max_age = -1;
    time (&p -> birth);
    return p;
}

cookies_destroy()

void cookies_destroy

(

List *

)

Definition at line 100 of file cookies.c.

References cookie_destroy(), gwlib_assert_init(), and gwlist_destroy().

{
    gwlib_assert_init();

    if (cookies == NULL)
        return;

    gwlist_destroy(cookies, cookie_destroy);
}

get_cookies()

int get_cookies	(	List *	,
		const WSPMachine *
	)

Definition at line 111 of file cookies.c.

References add_cookie_to_cache(), cookie_destroy(), debug(), error(), get_header_value(), gwlist_get(), gwlist_len(), have_cookie(), info(), name, octstr_get_cstr, and parse_cookie().

Referenced by return_reply().

{
    Octstr *header = NULL;
    Octstr *value = NULL;
    Cookie *cookie = NULL;
    long pos = 0;

    /* 
     * This can happen if the user aborts while the HTTP request is pending from the server.
     * In that case, the session machine is destroyed and is not available to this function
     * for cookie caching.
     */

    if (sm == NULL) {
        info (0, "No session machine for cookie retrieval");
        return 0;
    }

    for (pos = 0; pos < gwlist_len(headers); pos++) {
        header = gwlist_get(headers, pos);
        /* debug ("wap.wsp.http", 0, "get_cookies: Examining header (%s)", octstr_get_cstr (header)); */
        if (strncasecmp ("set-cookie", octstr_get_cstr (header),10) == 0) {     
            debug ("wap.wsp.http", 0, "Caching cookie (%s)", octstr_get_cstr (header));

            if ((value = get_header_value (header)) == NULL) {
                error (0, "get_cookies: No value in (%s)", octstr_get_cstr(header));
                continue;
            }

            /* Parse the received cookie */
            if ((cookie = parse_cookie(value)) != NULL) {

                /* Check to see if this cookie is already present */
                if (have_cookie(sm->cookies, cookie) == 1) {
                    debug("wap.wsp.http", 0, "parse_cookie: Cookie present");
                          cookie_destroy(cookie);
                    continue;
                } else {
                    add_cookie_to_cache(sm, cookie);
                    debug("wap.wsp.http", 0, "get_cookies: Added (%s)", 
                          octstr_get_cstr(cookie -> name));
                }
            }
        }
    }

    debug("wap.wsp.http", 0, "get_cookies: End");
    return 0;
}

set_cookies()

int set_cookies	(	List *	,
		WSPMachine *
	)

Definition at line 162 of file cookies.c.

References debug(), _cookie::domain, error(), expire_cookies(), gwlist_append(), gwlist_get(), gwlist_len(), _cookie::name, octstr_append(), octstr_append_char(), octstr_create, octstr_get_cstr, _cookie::path, _cookie::value, and _cookie::version.

Referenced by start_fetch().

{
    Cookie *value = NULL;
    Octstr *cookie = NULL;
    long pos = 0;

    if (headers == NULL || sm == NULL) {
        error (0, "set_cookies: Null argument(s) - no headers, WSPMachine or both");
        return -1;
    }

    /* Expire cookies that have timed out */
    expire_cookies(sm->cookies);

    /* Walk through the cookie cache, adding the cookie to the request headers */
    if (gwlist_len(sm->cookies) > 0) {
        debug("wap.wsp.http", 0, "set_cookies: Cookies in cache");

        for (pos = 0; pos < gwlist_len(sm->cookies); pos++) {
            value = gwlist_get(sm->cookies, pos);

            cookie = octstr_create("Cookie: ");
            if (value->version) 
                octstr_append(cookie, value->version);
            octstr_append(cookie, value->name);
            octstr_append_char(cookie, '=');
            octstr_append(cookie, value->value);

            if (value->path) {
                octstr_append_char(cookie, ';');
                octstr_append(cookie, value->path);
            }
            if (value->domain) {
                octstr_append_char(cookie, ';');
                octstr_append(cookie, value->domain);
            }

            gwlist_append(headers, cookie);
            debug("wap.wsp.http", 0, "set_cookies: Added (%s)", octstr_get_cstr (cookie));
        }
    } else
        debug("wap.wsp.http", 0, "set_cookies: No cookies in cache");

    return 0;
}