JSTONE.js

function JSTONE( JSON, free, clear )

Create a JSTONE instance.  You can create only one instance for each page.

Arguments

Note

JavaScript is a scripting language parsed runtime and its native functions behaviour should be changed by malicious user.  It’s a good practice to don’t save private data/informations inside cookies and in this case should be a good practice don’t save these kind of informations inside JSTONE too.  Please remember that JSTONE is based on window.name property and everyone, from every site, should read this property parsing them using JSON.  This is another reason to don’t believe on JSTONE object for personal data or private informations even if You use last clear argument to remove every information from window.name property.

this.clear = function()

destroy every private object information.

Example

MySTONE = new JSTONE(JSON);

// verify if JSTONE was used in your site
if(MySTONE.read("domain") !== "mysite")
       MySTONE.clear();

MySTONE.write("domain", "mysite");

Example [paranoia version]

// using server side informations, in this case a PHP session id
// malicious users cannot know which SID outgoing client will recieve
SID = "<?php echo session_id(); ?>";

MySTONE = new JSTONE(JSON);
if(MySTONE.read("SID") !== SID) MySTONE.write("domain", MySTONE.clear() || SID);
// next time above check will not clear informations so You can believe on your instance informations.

Note

Malicious users should set window.name in their pages manually adding other site parameters.  This check should be based on server-side informations such session ID.  If generic STONE.read(“SID”) is different, session was expired or user doesn’t come from your site.  In this way You can have better and more secure (just a bit) control with your JSTONE instance.

this.read = function( key )

try to find a variable and return its value or undefined.

Arguments

Returns

Example 1

MySTONE = new JSTONE(JSON);

if(MySTONE.read("user"))
       with(MySTONE.read("user")) {
               alert([
                       name + " " + surname,
                       address + " " + city,
                       country
               ].join("\n"));
       }
else
       document.getElementById("myForm").onsubmit = function() {
               var     input = this.getElementsByTagName("input");
               MySTONE.write("user", {
                       name:input[0],
                       surname:input[1],
                       address:input[2],
                       city:input[3],
                       country:input[4]
               });
       };

Example 2

MySTONE = new JSTONE(JSON);
MySTONE.write("informations", {browser:navigator.userAgent, page:location.href});
MySTONE.read("informations.browser");  // user agent
MySTONE.read("informations").page;     // this page

Note

JSTONE search function creates automatically empty objects before last searched value if these are not defined.  If You search “user.name”, for example, “user” namespace will be created automatically.

this.write = function( key, value )

set a generic variable into selected namespace

Arguments

Example

MySTONE = new JSTONE(JSON);
MySTONE.write("informations", {browser:navigator.userAgent, page:location.href});
MySTONE.write("informations.user", {id:1, data:{name:"Mickey"}});
MySTONE.write("informations.user.data.age", 29);

Note

JSTONE search function creates automatically empty objects before last namespace value if these are not defined.  Namespace uses dot convention “.” to separate each value.