/* cookies.js -- Code implementing basic operations on JavaScript cookies.  */

/*
 * Copyright (C) 2003 Tudor Hulubei <tudor@hulubei.net>.
 * Distributed under the GNU General Public License.
 */


/* Set a cookie.  An argument defaults when it is assigned null
 * as a placeholder.  A null placeholder is not required for
 * trailing omitted arguments.
 *
 *   [name] - name of the cookie.
 *   [value] - value of the cookie.
 *   [expires] - expiration date of the cookie
 *               (defaults to end of current session).
 *   [path] - path for which the cookie is valid
 *            (defaults to path of calling document).
 *   [domain] - domain for which the cookie is valid
 *              (defaults to domain of calling document).
 *   [secure] - Boolean value indicating if the cookie
 *              transmission requires a secure transmission.
 */
function SetCookie(name, value, expires, path, domain, secure)
{
    var currentCookie = name + '=' + escape(value) +
        ((expires) ? '; expires=' + expires.toGMTString() : '') +
        ((path) ? '; path=' + path : '') +
        ((domain) ? '; domain=' + domain : '') +
        ((secure) ? '; secure' : '');
    document.cookie = currentCookie;
}


/*
 * Get a cookie.  Return string containing the value of the specified
 * cookie or null if the cookie does not exist.
 *
 *   [name] - the name of the desired cookie.
 */
function GetCookie(name)
{
    var dc = document.cookie;
    var prefix = name + '=';
    var begin = dc.indexOf('; ' + prefix);

    if (begin == -1)
    {
        begin = dc.indexOf(prefix);
        if (begin != 0)
            return null;
    }
    else
        begin += 2;

    var end = document.cookie.indexOf(';', begin);

    if (end == -1)
        end = dc.length;

    return unescape(dc.substring(begin + prefix.length, end));
}


/*
 * Delete a cookie.  Path and domain default if assigned null
 * or omitted if no explicit argument proceeds.
 *
 *  [name] - the name of the cookie.
 *  [path] - the path of the cookie (must be same as
 *           path used to create the cookie).
 *  [domain] - the domain of the cookie (must be same as
 *             domain used to create the cookie).
 */
function DeleteCookie(name, path, domain)
{
    if (GetCookie(name))
    {
        document.cookie = name + '=' +
            ((path) ? '; path=' + path : '') +
            ((domain) ? '; domain=' + domain : '') +
            '; expires=Thu, 01-Jan-70 00:00:01 GMT';
    }
}


/*
 * Fix the date to compensate for a bug in Navigator 2.0, Macintosh.
 * Hand all instances of the Date object to this function for "repairs".
 *
 *   [date] - any instance of the Date object.
 */
function FixDate(date)
{
    var base = new Date(0);
    var skew = base.getTime();

    if (skew > 0)
        date.setTime(date.getTime() - skew);
}


/* Local Variables: */
/* mode: C++ */
/* End: */