/**
* JIO Local Storage. Type = 'local'.
* Local browser "database" storage.
*/
var newLocalStorage = function (spec, my) {
spec = spec || {};
var that = my.basicStorage(spec, my),
priv = {},
/*
* Wrapper for the localStorage used to simplify instion of any kind of
* values
*/
localstorage = {
getItem: function (item) {
return JSON.parse(localStorage.getItem(item));
},
setItem: function (item, value) {
return localStorage.setItem(item, JSON.stringify(value));
},
deleteItem: function (item) {
delete localStorage[item];
}
},
storage_user_array_name,
storage_file_array_name;
// attributes
priv.username = spec.username || '';
priv.applicationname = spec.applicationname || 'untitled';
storage_user_array_name = 'jio/local_user_array';
storage_file_array_name = 'jio/local_file_name_array/' +
priv.username + '/' + priv.applicationname;
/**
* Returns a list of users.
* @method getUserArray
* @return {array} The list of users.
*/
priv.getUserArray = function () {
return localstorage.getItem(storage_user_array_name) || [];
};
/**
* Adds a user to the user list.
* @method addUser
* @param {string} user_name The user name.
*/
priv.addUser = function (user_name) {
var user_array = priv.getUserArray();
user_array.push(user_name);
localstorage.setItem(storage_user_array_name, user_array);
};
/**
* checks if a user exists in the user array.
* @method doesUserExist
* @param {string} user_name The user name
* @return {boolean} true if exist, else false
*/
priv.doesUserExist = function (user_name) {
var user_array = priv.getUserArray(), i, l;
for (i = 0, l = user_array.length; i < l; i += 1) {
if (user_array[i] === user_name) {
return true;
}
}
return false;
};
/**
* Returns the file names of all existing files owned by the user.
* @method getFileNameArray
* @return {array} All the existing file paths.
*/
priv.getFileNameArray = function () {
return localstorage.getItem(storage_file_array_name) || [];
};
/**
* Adds a file name to the local file name array.
* @method addFileName
* @param {string} file_name The new file name.
*/
priv.addFileName = function (file_name) {
var file_name_array = priv.getFileNameArray();
file_name_array.push(file_name);
localstorage.setItem(storage_file_array_name, file_name_array);
};
/**
* Removes a file name from the local file name array.
* @method removeFileName
* @param {string} file_name The file name to remove.
*/
priv.removeFileName = function (file_name) {
var i, l, array = priv.getFileNameArray(), new_array = [];
for (i = 0, l = array.length; i < l; i+= 1) {
if (array[i] !== file_name) {
new_array.push(array[i]);
}
}
localstorage.setItem(storage_file_array_name, new_array);
};
/**
* Extends [obj] adding 0 to 3 values according to [command] options.
* @method manageOptions
* @param {object} obj The obj to extend
* @param {object} command The JIO command
* @param {object} doc The document object
*/
priv.manageOptions = function (obj, command, doc) {
obj = obj || {};
if (command.getOption('revs')) {
obj.revisions = doc._revisions;
}
if (command.getOption('revs_info')) {
obj.revs_info = doc._revs_info;
}
if (command.getOption('conflicts')) {
obj.conflicts = {total_rows:0, rows:[]};
}
return obj;
};
/**
* Update [doc] the document object and remove [doc] keys
* which are not in [new_doc]. It only changes [doc] keys not starting
* with an underscore.
* ex: doc: {key:value1,_key:value2} with
* new_doc: {key:value3,_key:value4} updates
* doc: {key:value3,_key:value2}.
* @param {object} doc The original document object.
* @param {object} new_doc The new document object
*/
priv.documentObjectUpdate = function (doc, new_doc) {
var k;
for (k in doc) {
if (k[0] !== '_') {
delete doc[k];
}
}
for (k in new_doc) {
if (k[0] !== '_') {
doc[k] = new_doc[k];
}
}
};
/**
* Create a new document
* @param {object} command Command object
*/
priv.runDocumenCreate = function (docid, command){
var docId = command.getDocId(),
docPath = 'jio/local/'+priv.username+'/'+
priv.applicationname+'/'+docId,
doc = priv.createDocument( docId, docPath );
// store document
localstorage.setItem(docPath + '/' + doc._rev, doc);
// add user
if (!priv.doesUserExist(priv.username)) {
priv.addUser(priv.username);
}
// add fileName
priv.addFileName(docId);
// return SUCCESS
return priv.manageOptions(
{ok:true,id:docId,rev:doc._rev}, command, doc);
};
// ================== storage overrides =====================
that.serialized = function () {
return {
"applicationname": priv.applicationname,
"username": priv.username
};
};
// Overrinding validateState()
that.validateState = function() {
if (priv.username) {
return '';
}
return 'Need at least one parameter: "username".';
};
// Overriding storage post
/**
* @method _post - Create a document in local storage.
* @stored - 'jio/local/USR/APP/FILE_NAME/REVISION'.
*
* Available options:
* - {boolean} conflicts - Add a conflicts object to the response
* - {boolean} revs - Add the revisions history of the document
* - {boolean} revs_info - Add revisions informations
*
*/
that._post = function (command) {
setTimeout (function () {
// 403 - no attachments allowed
if (command.getAttachmentId()) {
that.error( that.createErrorObject( 403, 'Forbidden',
'Attachment cannot be added with a POST request')
);
return;
} else {
that.success(
priv.runDocumenCreate(command)
);
}
});
};
// Overriding storage put
/**
* @method put - Create or Update a document in local storage.
* @stored - 'jio/local/USR/APP/FILE_NAME/REVISION'.
*
* Available options:
* - {boolean} conflicts - Add a conflicts object to the response
* - {boolean} revs - Add the revisions history of the document
* - {boolean} revs_info - Add revisions informations
*/
that._put = function (command) {
setTimeout (function () {
});
};
// Overriding storage putAttachment
/**
* @method putAttachment - Saves/updates an attachment of a document
* @stored at - 'jio/local/USR/APP/FILE_NAME/REVISION/ATTACHMENTID'.
*
* Available options:
* - {boolean} conflicts - Add a conflicts object to the response
* - {boolean} revs - Add the revisions history of the document
* - {boolean} revs_info - Add revisions informations
*/
that._putAttachment = function (command) {
setTimeout (function () {
});
};
// Overriding storage get
/**
* Loads a document from the local storage.
* It will load file in 'jio/local/USR/APP/FILE_NAME'.
* @method get
*/
that._get = function (command) {
setTimeout (function () {
});
};
// Overriding storage remove
/**
* Removes a document or attachment from the local storage.
* It will also remove the path from the local file array.
* @method remove
*/
that._remove = function (command) {
setTimeout (function () {
});
};
// Overriding storage allDocs
/**
* Gets a document list from the local storage.
* It will retreive an array containing files meta data owned by
* the user.
* @method allDocs
*/
that.allDocs = function (command) {
setTimeout (function () {
});
};
return that;
};
jIO.addStorageType('local', newLocalStorage);