src/cm/media/js/lib/yui/yui_3.10.3/build/cookie/cookie.js
author Yves-Marie Haussonne <ymh.work+github@gmail.com>
Fri, 09 May 2014 18:35:26 +0200
changeset 656 a84519031134
parent 525 89ef5ed3c48b
permissions -rw-r--r--
add link to "privacy policy" in the header test
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
525
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
     1
/*
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
     2
YUI 3.10.3 (build 2fb5187)
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
     3
Copyright 2013 Yahoo! Inc. All rights reserved.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
     4
Licensed under the BSD License.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
     5
http://yuilibrary.com/license/
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
     6
*/
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
     7
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
     8
YUI.add('cookie', function (Y, NAME) {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
     9
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    10
/**
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    11
 * Utilities for cookie management
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    12
 * @module cookie
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    13
 */
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    14
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    15
    //shortcuts
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    16
    var L       = Y.Lang,
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    17
        O       = Y.Object,
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    18
        NULL    = null,
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    19
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    20
        //shortcuts to functions
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    21
        isString    = L.isString,
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    22
        isObject    = L.isObject,
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    23
        isUndefined = L.isUndefined,
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    24
        isFunction  = L.isFunction,
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    25
        encode      = encodeURIComponent,
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    26
        decode      = decodeURIComponent,
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    27
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    28
        //shortcut to document
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    29
        doc         = Y.config.doc;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    30
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    31
    /*
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    32
     * Throws an error message.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    33
     */
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    34
    function error(message){
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    35
        throw new TypeError(message);
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    36
    }
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    37
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    38
    /*
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    39
     * Checks the validity of a cookie name.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    40
     */
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    41
    function validateCookieName(name){
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    42
        if (!isString(name) || name === ""){
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    43
            error("Cookie name must be a non-empty string.");
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    44
        }
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    45
    }
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    46
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    47
    /*
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    48
     * Checks the validity of a subcookie name.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    49
     */
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    50
    function validateSubcookieName(subName){
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    51
        if (!isString(subName) || subName === ""){
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    52
            error("Subcookie name must be a non-empty string.");
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    53
        }
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    54
    }
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    55
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    56
    /**
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    57
     * Cookie utility.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    58
     * @class Cookie
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    59
     * @static
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    60
     */
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    61
    Y.Cookie = {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    62
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    63
        //-------------------------------------------------------------------------
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    64
        // Private Methods
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    65
        //-------------------------------------------------------------------------
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    66
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    67
        /**
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    68
         * Creates a cookie string that can be assigned into document.cookie.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    69
         * @param {String} name The name of the cookie.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    70
         * @param {String} value The value of the cookie.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    71
         * @param {Boolean} encodeValue True to encode the value, false to leave as-is.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    72
         * @param {Object} options (Optional) Options for the cookie.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    73
         * @return {String} The formatted cookie string.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    74
         * @method _createCookieString
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    75
         * @private
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    76
         * @static
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    77
         */
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    78
        _createCookieString : function (name /*:String*/, value /*:Variant*/, encodeValue /*:Boolean*/, options /*:Object*/) /*:String*/ {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    79
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    80
            options = options || {};
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    81
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    82
            var text /*:String*/ = encode(name) + "=" + (encodeValue ? encode(value) : value),
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    83
                expires = options.expires,
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    84
                path    = options.path,
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    85
                domain  = options.domain;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    86
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    87
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    88
            if (isObject(options)){
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    89
                //expiration date
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    90
                if (expires instanceof Date){
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    91
                    text += "; expires=" + expires.toUTCString();
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    92
                }
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    93
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    94
                //path
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    95
                if (isString(path) && path !== ""){
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    96
                    text += "; path=" + path;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    97
                }
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    98
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    99
                //domain
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   100
                if (isString(domain) && domain !== ""){
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   101
                    text += "; domain=" + domain;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   102
                }
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   103
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   104
                //secure
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   105
                if (options.secure === true){
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   106
                    text += "; secure";
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   107
                }
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   108
            }
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   109
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   110
            return text;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   111
        },
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   112
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   113
        /**
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   114
         * Formats a cookie value for an object containing multiple values.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   115
         * @param {Object} hash An object of key-value pairs to create a string for.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   116
         * @return {String} A string suitable for use as a cookie value.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   117
         * @method _createCookieHashString
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   118
         * @private
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   119
         * @static
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   120
         */
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   121
        _createCookieHashString : function (hash /*:Object*/) /*:String*/ {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   122
            if (!isObject(hash)){
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   123
                error("Cookie._createCookieHashString(): Argument must be an object.");
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   124
            }
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   125
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   126
            var text /*:Array*/ = [];
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   127
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   128
            O.each(hash, function(value, key){
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   129
                if (!isFunction(value) && !isUndefined(value)){
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   130
                    text.push(encode(key) + "=" + encode(String(value)));
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   131
                }
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   132
            });
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   133
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   134
            return text.join("&");
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   135
        },
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   136
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   137
        /**
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   138
         * Parses a cookie hash string into an object.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   139
         * @param {String} text The cookie hash string to parse (format: n1=v1&n2=v2).
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   140
         * @return {Object} An object containing entries for each cookie value.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   141
         * @method _parseCookieHash
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   142
         * @private
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   143
         * @static
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   144
         */
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   145
        _parseCookieHash : function (text) {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   146
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   147
            var hashParts   = text.split("&"),
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   148
                hashPart    = NULL,
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   149
                hash        = {};
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   150
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   151
            if (text.length){
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   152
                for (var i=0, len=hashParts.length; i < len; i++){
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   153
                    hashPart = hashParts[i].split("=");
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   154
                    hash[decode(hashPart[0])] = decode(hashPart[1]);
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   155
                }
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   156
            }
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   157
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   158
            return hash;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   159
        },
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   160
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   161
        /**
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   162
         * Parses a cookie string into an object representing all accessible cookies.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   163
         * @param {String} text The cookie string to parse.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   164
         * @param {Boolean} shouldDecode (Optional) Indicates if the cookie values should be decoded or not. Default is true.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   165
         * @param {Object} options (Optional) Contains settings for loading the cookie.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   166
         * @return {Object} An object containing entries for each accessible cookie.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   167
         * @method _parseCookieString
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   168
         * @private
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   169
         * @static
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   170
         */
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   171
        _parseCookieString : function (text /*:String*/, shouldDecode /*:Boolean*/, options /*:Object*/) /*:Object*/ {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   172
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   173
            var cookies /*:Object*/ = {};
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   174
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   175
            if (isString(text) && text.length > 0) {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   176
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   177
                var decodeValue = (shouldDecode === false ? function(s){return s;} : decode),
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   178
                    cookieParts = text.split(/;\s/g),
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   179
                    cookieName  = NULL,
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   180
                    cookieValue = NULL,
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   181
                    cookieNameValue = NULL;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   182
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   183
                for (var i=0, len=cookieParts.length; i < len; i++){
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   184
                    //check for normally-formatted cookie (name-value)
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   185
                    cookieNameValue = cookieParts[i].match(/([^=]+)=/i);
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   186
                    if (cookieNameValue instanceof Array){
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   187
                        try {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   188
                            cookieName = decode(cookieNameValue[1]);
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   189
                            cookieValue = decodeValue(cookieParts[i].substring(cookieNameValue[1].length+1));
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   190
                        } catch (ex){
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   191
                            //intentionally ignore the cookie - the encoding is wrong
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   192
                        }
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   193
                    } else {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   194
                        //means the cookie does not have an "=", so treat it as a boolean flag
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   195
                        cookieName = decode(cookieParts[i]);
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   196
                        cookieValue = "";
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   197
                    }
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   198
                    // don't overwrite an already loaded cookie if set by option
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   199
                    if (!isUndefined(options) && options.reverseCookieLoading) {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   200
                        if (isUndefined(cookies[cookieName])) {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   201
                            cookies[cookieName] = cookieValue;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   202
                        }
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   203
                    } else {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   204
                        cookies[cookieName] = cookieValue;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   205
                    }
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   206
                }
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   207
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   208
            }
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   209
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   210
            return cookies;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   211
        },
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   212
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   213
        /**
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   214
         * Sets the document object that the cookie utility uses for setting
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   215
         * cookies. This method is necessary to ensure that the cookie utility
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   216
         * unit tests can pass even when run on a domain instead of locally.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   217
         * This method should not be used otherwise; you should use
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   218
         * <code>Y.config.doc</code> to change the document that the cookie
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   219
         * utility uses for everyday purposes.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   220
         * @param {Object} newDoc The object to use as the document.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   221
         * @return {void}
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   222
         * @method _setDoc
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   223
         * @private
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   224
         */
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   225
        _setDoc: function(newDoc){
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   226
            doc = newDoc;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   227
        },
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   228
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   229
        //-------------------------------------------------------------------------
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   230
        // Public Methods
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   231
        //-------------------------------------------------------------------------
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   232
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   233
        /**
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   234
         * Determines if the cookie with the given name exists. This is useful for
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   235
         * Boolean cookies (those that do not follow the name=value convention).
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   236
         * @param {String} name The name of the cookie to check.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   237
         * @return {Boolean} True if the cookie exists, false if not.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   238
         * @method exists
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   239
         * @static
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   240
         */
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   241
        exists: function(name) {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   242
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   243
            validateCookieName(name);   //throws error
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   244
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   245
            var cookies = this._parseCookieString(doc.cookie, true);
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   246
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   247
            return cookies.hasOwnProperty(name);
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   248
        },
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   249
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   250
        /**
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   251
         * Returns the cookie value for the given name.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   252
         * @param {String} name The name of the cookie to retrieve.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   253
         * @param {Function|Object} options (Optional) An object containing one or more
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   254
         *      cookie options: raw (true/false), reverseCookieLoading (true/false)
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   255
         *      and converter (a function).
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   256
         *      The converter function is run on the value before returning it. The
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   257
         *      function is not used if the cookie doesn't exist. The function can be
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   258
         *      passed instead of the options object for backwards compatibility. When
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   259
         *      raw is set to true, the cookie value is not URI decoded.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   260
         * @return {Variant} If no converter is specified, returns a string or null if
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   261
         *      the cookie doesn't exist. If the converter is specified, returns the value
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   262
         *      returned from the converter or null if the cookie doesn't exist.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   263
         * @method get
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   264
         * @static
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   265
         */
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   266
        get : function (name, options) {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   267
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   268
            validateCookieName(name);   //throws error
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   269
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   270
            var cookies,
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   271
                cookie,
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   272
                converter;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   273
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   274
            //if options is a function, then it's the converter
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   275
            if (isFunction(options)) {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   276
                converter = options;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   277
                options = {};
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   278
            } else if (isObject(options)) {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   279
                converter = options.converter;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   280
            } else {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   281
                options = {};
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   282
            }
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   283
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   284
            cookies = this._parseCookieString(doc.cookie, !options.raw, options);
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   285
            cookie = cookies[name];
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   286
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   287
            //should return null, not undefined if the cookie doesn't exist
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   288
            if (isUndefined(cookie)) {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   289
                return NULL;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   290
            }
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   291
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   292
            if (!isFunction(converter)){
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   293
                return cookie;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   294
            } else {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   295
                return converter(cookie);
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   296
            }
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   297
        },
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   298
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   299
        /**
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   300
         * Returns the value of a subcookie.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   301
         * @param {String} name The name of the cookie to retrieve.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   302
         * @param {String} subName The name of the subcookie to retrieve.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   303
         * @param {Function} converter (Optional) A function to run on the value before returning
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   304
         *      it. The function is not used if the cookie doesn't exist.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   305
         * @param {Object} options (Optional) Containing one or more settings for cookie parsing.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   306
         * @return {Variant} If the cookie doesn't exist, null is returned. If the subcookie
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   307
         *      doesn't exist, null if also returned. If no converter is specified and the
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   308
         *      subcookie exists, a string is returned. If a converter is specified and the
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   309
         *      subcookie exists, the value returned from the converter is returned.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   310
         * @method getSub
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   311
         * @static
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   312
         */
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   313
        getSub : function (name /*:String*/, subName /*:String*/, converter /*:Function*/, options /*:Object*/) /*:Variant*/ {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   314
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   315
            var hash /*:Variant*/ = this.getSubs(name, options);
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   316
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   317
            if (hash !== NULL) {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   318
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   319
                validateSubcookieName(subName);   //throws error
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   320
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   321
                if (isUndefined(hash[subName])){
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   322
                    return NULL;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   323
                }
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   324
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   325
                if (!isFunction(converter)){
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   326
                    return hash[subName];
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   327
                } else {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   328
                    return converter(hash[subName]);
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   329
                }
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   330
            } else {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   331
                return NULL;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   332
            }
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   333
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   334
        },
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   335
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   336
        /**
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   337
         * Returns an object containing name-value pairs stored in the cookie with the given name.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   338
         * @param {String} name The name of the cookie to retrieve.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   339
         * @param {Object} options (Optional) Containing one or more settings for cookie parsing.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   340
         * @return {Object} An object of name-value pairs if the cookie with the given name
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   341
         *      exists, null if it does not.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   342
         * @method getSubs
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   343
         * @static
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   344
         */
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   345
        getSubs : function (name /*:String*/, options /*:Object*/) {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   346
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   347
            validateCookieName(name);   //throws error
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   348
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   349
            var cookies = this._parseCookieString(doc.cookie, false, options);
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   350
            if (isString(cookies[name])){
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   351
                return this._parseCookieHash(cookies[name]);
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   352
            }
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   353
            return NULL;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   354
        },
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   355
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   356
        /**
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   357
         * Removes a cookie from the machine by setting its expiration date to
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   358
         * sometime in the past.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   359
         * @param {String} name The name of the cookie to remove.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   360
         * @param {Object} options (Optional) An object containing one or more
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   361
         *      cookie options: path (a string), domain (a string),
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   362
         *      and secure (true/false). The expires option will be overwritten
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   363
         *      by the method.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   364
         * @return {String} The created cookie string.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   365
         * @method remove
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   366
         * @static
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   367
         */
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   368
        remove : function (name, options) {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   369
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   370
            validateCookieName(name);   //throws error
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   371
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   372
            //set options
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   373
            options = Y.merge(options || {}, {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   374
                expires: new Date(0)
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   375
            });
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   376
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   377
            //set cookie
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   378
            return this.set(name, "", options);
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   379
        },
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   380
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   381
        /**
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   382
         * Removes a sub cookie with a given name.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   383
         * @param {String} name The name of the cookie in which the subcookie exists.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   384
         * @param {String} subName The name of the subcookie to remove.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   385
         * @param {Object} options (Optional) An object containing one or more
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   386
         *      cookie options: path (a string), domain (a string), expires (a Date object),
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   387
         *      removeIfEmpty (true/false), and secure (true/false). This must be the same
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   388
         *      settings as the original subcookie.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   389
         * @return {String} The created cookie string.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   390
         * @method removeSub
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   391
         * @static
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   392
         */
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   393
        removeSub : function(name, subName, options) {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   394
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   395
            validateCookieName(name);   //throws error
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   396
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   397
            validateSubcookieName(subName);   //throws error
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   398
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   399
            options = options || {};
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   400
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   401
            //get all subcookies for this cookie
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   402
            var subs = this.getSubs(name);
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   403
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   404
            //delete the indicated subcookie
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   405
            if (isObject(subs) && subs.hasOwnProperty(subName)){
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   406
                delete subs[subName];
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   407
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   408
                if (!options.removeIfEmpty) {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   409
                    //reset the cookie
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   410
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   411
                    return this.setSubs(name, subs, options);
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   412
                } else {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   413
                    //reset the cookie if there are subcookies left, else remove
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   414
                    for (var key in subs){
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   415
                        if (subs.hasOwnProperty(key) && !isFunction(subs[key]) && !isUndefined(subs[key])){
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   416
                            return this.setSubs(name, subs, options);
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   417
                        }
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   418
                    }
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   419
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   420
                    return this.remove(name, options);
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   421
                }
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   422
            } else {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   423
                return "";
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   424
            }
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   425
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   426
        },
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   427
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   428
        /**
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   429
         * Sets a cookie with a given name and value.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   430
         * @param {String} name The name of the cookie to set.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   431
         * @param {Variant} value The value to set for the cookie.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   432
         * @param {Object} options (Optional) An object containing one or more
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   433
         *      cookie options: path (a string), domain (a string), expires (a Date object),
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   434
         *      secure (true/false), and raw (true/false). Setting raw to true indicates
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   435
         *      that the cookie should not be URI encoded before being set.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   436
         * @return {String} The created cookie string.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   437
         * @method set
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   438
         * @static
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   439
         */
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   440
        set : function (name, value, options) {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   441
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   442
            validateCookieName(name);   //throws error
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   443
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   444
            if (isUndefined(value)){
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   445
                error("Cookie.set(): Value cannot be undefined.");
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   446
            }
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   447
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   448
            options = options || {};
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   449
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   450
            var text = this._createCookieString(name, value, !options.raw, options);
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   451
            doc.cookie = text;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   452
            return text;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   453
        },
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   454
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   455
        /**
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   456
         * Sets a sub cookie with a given name to a particular value.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   457
         * @param {String} name The name of the cookie to set.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   458
         * @param {String} subName The name of the subcookie to set.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   459
         * @param {Variant} value The value to set.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   460
         * @param {Object} options (Optional) An object containing one or more
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   461
         *      cookie options: path (a string), domain (a string), expires (a Date object),
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   462
         *      and secure (true/false).
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   463
         * @return {String} The created cookie string.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   464
         * @method setSub
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   465
         * @static
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   466
         */
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   467
        setSub : function (name, subName, value, options) {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   468
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   469
            validateCookieName(name);   //throws error
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   470
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   471
            validateSubcookieName(subName);   //throws error
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   472
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   473
            if (isUndefined(value)){
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   474
                error("Cookie.setSub(): Subcookie value cannot be undefined.");
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   475
            }
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   476
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   477
            var hash = this.getSubs(name);
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   478
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   479
            if (!isObject(hash)){
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   480
                hash = {};
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   481
            }
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   482
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   483
            hash[subName] = value;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   484
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   485
            return this.setSubs(name, hash, options);
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   486
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   487
        },
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   488
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   489
        /**
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   490
         * Sets a cookie with a given name to contain a hash of name-value pairs.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   491
         * @param {String} name The name of the cookie to set.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   492
         * @param {Object} value An object containing name-value pairs.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   493
         * @param {Object} options (Optional) An object containing one or more
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   494
         *      cookie options: path (a string), domain (a string), expires (a Date object),
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   495
         *      and secure (true/false).
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   496
         * @return {String} The created cookie string.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   497
         * @method setSubs
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   498
         * @static
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   499
         */
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   500
        setSubs : function (name, value, options) {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   501
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   502
            validateCookieName(name);   //throws error
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   503
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   504
            if (!isObject(value)){
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   505
                error("Cookie.setSubs(): Cookie value must be an object.");
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   506
            }
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   507
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   508
            var text /*:String*/ = this._createCookieString(name, this._createCookieHashString(value), false, options);
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   509
            doc.cookie = text;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   510
            return text;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   511
        }
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   512
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   513
    };
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   514
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   515
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   516
}, '3.10.3', {"requires": ["yui-base"]});