Cookies on Roids -JSON Based

Antonio Ramirez — Fri, 01 Jan 2010 21:13:25 +0000

Every Web programmer, one day or another, works with cookies. Some of us prefer to use server side cookies, others client cookies, and also both, client and server cookies. On my older blogspot blog, one that I even really care to update everyday as I do with this one, I post one class to work with cookies on the client side and one fellow programmer told me about json cookies. I thought it was a great script and that was because by using JSON (thanks David Crockford again!) encoding we could save objects and arrays of information into our good friends ‘cookies’.

Well, on my last post, I have included a JSON Plugin script to use with JQuery. By making a couple of modifications I have created a Cookie and JSON javascript objects to provide you with the possibility to save objects and arrays on cookies. Both of the objects do not require any other dependency library…

Here is the script:



var JSON = {

    useHasOwn : ({}.hasOwnProperty ? true : false),

  	pad : function(n) {

        return n < 10 ? "0" + n : n;

    },

    m : {

        "\b": '\\b',

        "\t": '\\t',

        "\n": '\\n',

        "\f": '\\f',

        "\r": '\\r',

        '"' : '\\"',

        "\\": '\\\\'

    },

    encodeString : function(s){

        if (/["\\\x00-\x1f]/.test(s)) {

            return '"' + s.replace(/([\x00-\x1f\\"])/g, function(a, b) {

                var c = m[b];

                if(c){

                    return c;

                }

                c = b.charCodeAt();

                return "\\u00" +

                    Math.floor(c / 16).toString(16) +

                    (c % 16).toString(16);

            }) + '"';

        }

        return '"' + s + '"';

    },

    encodeArray : function(o){

        var a = ["["], b, i, l = o.length, v;

            for (i = 0; i < l; i += 1) {

                v = o[i];

                switch (typeof v) {

                    case "undefined":

                    case "function":

                    case "unknown":

                        break;

                    default:

                        if (b) {

                            a.push(',');

                        }

                        a.push(v === null ? "null" : JSON.encode(v));

                        b = true;

                }

            }

            a.push("]");

            return a.join("");

    },

    encodeDate : function(o){

        return '"' + o.getFullYear() + "-" +

                pad(o.getMonth() + 1) + "-" +

                pad(o.getDate()) + "T" +

                pad(o.getHours()) + ":" +

                pad(o.getMinutes()) + ":" +

                pad(o.getSeconds()) + '"';

    },

    encode : function(o){

        if(typeof o == "undefined" || o === null){

            return "null";

        }else if(o instanceof Array){

            return JSON.encodeArray(o);

        }else if(o instanceof Date){

            return JSON.encodeDate(o);

        }else if(typeof o == "string"){

            return JSON.encodeString(o);

        }else if(typeof o == "number"){

            return isFinite(o) ? String(o) : "null";

        }else if(typeof o == "boolean"){

            return String(o);

        }else {

            var a = ["{"], b, i, v;

            for (i in o) {

                if(!JSON.useHasOwn || o.hasOwnProperty(i)) {

                    v = o[i];

                    switch (typeof v) {

                    case "undefined":

                    case "function":

                    case "unknown":

                        break;

                    default:

                        if(b){

                            a.push(',');

                        }

                        a.push(JSON.encode(i), ":",

                                v === null ? "null" : JSON.encode(v));

                        b = true;

                    }

                }

            }

            a.push("}");

            return a.join("");

        }

    },

    decode : function(json){

        return eval("(" + json + ')');

    }

};
var Cookie = {

	jsonencode : JSON.encode,

	jsondecode : JSON.decode,
   	set : function(name,value,options){
   		options = this.extend({}, options);
        if (value === null) {

            value = '';

            options.expires = -1;

        }

        var expires = '';

        if (options.expires && (typeof options.expires == 'number' || options.expires.toUTCString)) {

            var date;

            if (typeof options.expires == 'number') {

                date = new Date();

                date.setTime(date.getTime() + (options.expires * 24 * 60 * 60 * 1000));

            } else {

                date = options.expires;

            }

            expires = '; expires=' + date.toUTCString();

        }
        var self = this;
  		value = options.json ? encodeURIComponent(Cookie.jsonencode(value)):encodeURIComponent(value);
        var path = options.path ? '; path=' + (options.path) : '';

        var domain = options.domain ? '; domain=' + (options.domain) : '';

        var secure = options.secure ? '; secure' : '';
        document.cookie = [name, '=', value, expires, path, domain, secure].join('');

	},

	get : function(name,json){
		var cookieValue = null;
        if (document.cookie && document.cookie != '') {

            var cookies = document.cookie.split(';');

            for (var i = 0; i < cookies.length; i++) {

                var cookie = this.trim(cookies[i]);

                // Does this cookie string begin with the name we want?

                if (cookie.substring(0, name.length + 1) == (name + '=')) {

                    cookieValue = json ? this.jsondecode(decodeURIComponent(cookie.substring(name.length + 1))):decodeURIComponent(cookie.substring(name.length + 1));

                    break;

                }

            }

        }
        return cookieValue;
	},

	unset: function(name){

		Cookie.set(name,'',-1);

	},

	trim: function( val ) {

		return (val || "").replace( /^\s+|\s+$/g, "" );

	},

	extend: function()

	{

		var target = arguments[0] || {}, i = 1, length = arguments.length, deep = false, options;

		if ( typeof target === "boolean" ) {

			deep = target;

			target = arguments[1] || {};

			i = 2;

		}

		if ( typeof target !== "object" && !isFunction(target) )

			target = {};

		if ( length == i ) {

			target = this;

			--i;

		}

		for ( ; i < length; i++ )

			if ( (options = arguments[ i ]) != null )

				for ( var name in options ) {

					var src = target[ name ], copy = options[ name ];
					if ( target === copy )

						continue;
					if ( deep && copy && typeof copy === "object" && !copy.nodeType )

						target[ name ] = this.extend( deep,

							src || ( copy.length != null ? [ ] : { } )

						, copy );
					else if ( copy !== undefined )

						target[ name ] = copy;
				}

		return target;

	},

	isFunction: function(obj){

		return toString.call(obj) === "[object Function]";

	}

};

As you can see above, I have included a couple of methods that allow me to extend the options of the object at will (thanks jQuery). I believe that you will find it quite useful to extend its functionality. Any ideas will be highly appreciated.

How to use it


// Create a cookie with the given name and value and other optional parameters.

//

// session cookie -no json

Cookie.set('the_cookie_name', 'the_value');
// get cookie (no json):

var cv = Cookie.get('the_cookie_name');
// session cookie -json, the value can be an object or an array too

Cookie.set('the_cookie_name', 'the_value', {json:true});
// get the cookie (json)

var cv = Cookie.get('the_cookie_name',true);
// Secured cookie, expiring in 14 days

Cookie.set('the_cookie_name', 'the_value', { expires: 14, path: '/', domain: 'yourdomain.com', secure: true });
// Deleting a cookie

Cookie.unset('the_cookie_name', null);

DOWNLOAD

download: Cookies on Roids (2.18KB)
added: 01/01/2010
clicks: 768

Tweet this!

El Blog del Antonio » Cookies

Cookies on Roids -JSON Based