555 lines
20 KiB
JavaScript
555 lines
20 KiB
JavaScript
/*
|
|
* jQuery Storage API Plugin
|
|
*
|
|
* Copyright (c) 2013 Julien Maurel
|
|
*
|
|
* Licensed under the MIT license:
|
|
* http://www.opensource.org/licenses/mit-license.php
|
|
*
|
|
* Project home:
|
|
* https://github.com/julien-maurel/jQuery-Storage-API
|
|
*
|
|
* Version: 1.9.4
|
|
*/
|
|
(function (factory) {
|
|
if (typeof define === 'function' && define.amd) {
|
|
// AMD
|
|
define(['jquery'], factory);
|
|
} else if (typeof exports === 'object') {
|
|
// CommonJS
|
|
factory(require('jquery'));
|
|
} else {
|
|
// Browser globals
|
|
factory(jQuery);
|
|
}
|
|
}(function ($) {
|
|
// Prefix to use with cookie fallback
|
|
var cookie_local_prefix = "ls_";
|
|
var cookie_session_prefix = "ss_";
|
|
|
|
// Get items from a storage
|
|
function _get() {
|
|
var storage = this._type, l = arguments.length, s = window[storage], a = arguments, a0 = a[0], vi, ret, tmp;
|
|
if (l < 1) {
|
|
throw new Error('Minimum 1 argument must be given');
|
|
} else if ($.isArray(a0)) {
|
|
// If second argument is an array, return an object with value of storage for each item in this array
|
|
ret = {};
|
|
for (var i in a0) {
|
|
vi = a0[i];
|
|
try {
|
|
ret[vi] = JSON.parse(s.getItem(vi));
|
|
} catch (e) {
|
|
ret[vi] = s.getItem(vi);
|
|
}
|
|
}
|
|
return ret;
|
|
} else if (l == 1) {
|
|
// If only 1 argument, return value directly
|
|
try {
|
|
return JSON.parse(s.getItem(a0));
|
|
} catch (e) {
|
|
return s.getItem(a0);
|
|
}
|
|
} else {
|
|
// If more than 1 argument, parse storage to retrieve final value to return it
|
|
// Get first level
|
|
try {
|
|
ret = JSON.parse(s.getItem(a0));
|
|
} catch (e) {
|
|
throw new ReferenceError(a0 + ' is not defined in this storage');
|
|
}
|
|
// Parse next levels
|
|
for (var i = 1; i < l - 1; i++) {
|
|
ret = ret[a[i]];
|
|
if (ret === undefined) {
|
|
throw new ReferenceError([].slice.call(a, 1, i + 1).join('.') + ' is not defined in this storage');
|
|
}
|
|
}
|
|
// If last argument is an array, return an object with value for each item in this array
|
|
// Else return value normally
|
|
if ($.isArray(a[i])) {
|
|
tmp = ret;
|
|
ret = {};
|
|
for (var j in a[i]) {
|
|
ret[a[i][j]] = tmp[a[i][j]];
|
|
}
|
|
return ret;
|
|
} else {
|
|
return ret[a[i]];
|
|
}
|
|
}
|
|
}
|
|
|
|
// Set items of a storage
|
|
function _set() {
|
|
var storage = this._type, l = arguments.length, s = window[storage], a = arguments, a0 = a[0], a1 = a[1], vi, to_store = isNaN(a1)?{}:[], type, tmp;
|
|
if (l < 1 || !$.isPlainObject(a0) && l < 2) {
|
|
throw new Error('Minimum 2 arguments must be given or first parameter must be an object');
|
|
} else if ($.isPlainObject(a0)) {
|
|
// If first argument is an object, set values of storage for each property of this object
|
|
for (var i in a0) {
|
|
vi = a0[i];
|
|
if (!$.isPlainObject(vi) && !this.alwaysUseJson) {
|
|
s.setItem(i, vi);
|
|
} else {
|
|
s.setItem(i, JSON.stringify(vi));
|
|
}
|
|
}
|
|
return a0;
|
|
} else if (l == 2) {
|
|
// If only 2 arguments, set value of storage directly
|
|
if (typeof a1 === 'object' || this.alwaysUseJson) {
|
|
s.setItem(a0, JSON.stringify(a1));
|
|
} else {
|
|
s.setItem(a0, a1);
|
|
}
|
|
return a1;
|
|
} else {
|
|
// If more than 3 arguments, parse storage to retrieve final node and set value
|
|
// Get first level
|
|
try {
|
|
tmp = s.getItem(a0);
|
|
if (tmp != null) {
|
|
to_store = JSON.parse(tmp);
|
|
}
|
|
} catch (e) {
|
|
}
|
|
tmp = to_store;
|
|
// Parse next levels and set value
|
|
for (var i = 1; i < l - 2; i++) {
|
|
vi = a[i];
|
|
type = isNaN(a[i+1])?"object":"array";
|
|
if (!tmp[vi] || type == "object" && !$.isPlainObject(tmp[vi]) || type=="array" && !$.isArray(tmp[vi])) {
|
|
if(type=="array") tmp[vi] = [];
|
|
else tmp[vi] = {};
|
|
}
|
|
tmp = tmp[vi];
|
|
}
|
|
tmp[a[i]] = a[i + 1];
|
|
s.setItem(a0, JSON.stringify(to_store));
|
|
return to_store;
|
|
}
|
|
}
|
|
|
|
// Remove items from a storage
|
|
function _remove() {
|
|
var storage = this._type, l = arguments.length, s = window[storage], a = arguments, a0 = a[0], to_store, tmp;
|
|
if (l < 1) {
|
|
throw new Error('Minimum 1 argument must be given');
|
|
} else if ($.isArray(a0)) {
|
|
// If first argument is an array, remove values from storage for each item of this array
|
|
for (var i in a0) {
|
|
s.removeItem(a0[i]);
|
|
}
|
|
return true;
|
|
} else if (l == 1) {
|
|
// If only 2 arguments, remove value from storage directly
|
|
s.removeItem(a0);
|
|
return true;
|
|
} else {
|
|
// If more than 2 arguments, parse storage to retrieve final node and remove value
|
|
// Get first level
|
|
try {
|
|
to_store = tmp = JSON.parse(s.getItem(a0));
|
|
} catch (e) {
|
|
throw new ReferenceError(a0 + ' is not defined in this storage');
|
|
}
|
|
// Parse next levels and remove value
|
|
for (var i = 1; i < l - 1; i++) {
|
|
tmp = tmp[a[i]];
|
|
if (tmp === undefined) {
|
|
throw new ReferenceError([].slice.call(a, 1, i).join('.') + ' is not defined in this storage');
|
|
}
|
|
}
|
|
// If last argument is an array,remove value for each item in this array
|
|
// Else remove value normally
|
|
if ($.isArray(a[i])) {
|
|
for (var j in a[i]) {
|
|
delete tmp[a[i][j]];
|
|
}
|
|
} else {
|
|
delete tmp[a[i]];
|
|
}
|
|
s.setItem(a0, JSON.stringify(to_store));
|
|
return true;
|
|
}
|
|
}
|
|
|
|
// Remove all items from a storage
|
|
function _removeAll(reinit_ns) {
|
|
var keys = _keys.call(this);
|
|
for (var i in keys) {
|
|
_remove.call(this, keys[i]);
|
|
}
|
|
// Reinitialize all namespace storages
|
|
if (reinit_ns) {
|
|
for (var i in $.namespaceStorages) {
|
|
_createNamespace(i);
|
|
}
|
|
}
|
|
}
|
|
|
|
// Check if items of a storage are empty
|
|
function _isEmpty() {
|
|
var l = arguments.length, a = arguments, a0 = a[0];
|
|
if (l == 0) {
|
|
// If no argument, test if storage is empty
|
|
return (_keys.call(this).length == 0);
|
|
} else if ($.isArray(a0)) {
|
|
// If first argument is an array, test each item of this array and return true only if all items are empty
|
|
for (var i = 0; i < a0.length; i++) {
|
|
if (!_isEmpty.call(this, a0[i])) {
|
|
return false;
|
|
}
|
|
}
|
|
return true;
|
|
} else {
|
|
// If at least 1 argument, try to get value and test it
|
|
try {
|
|
var v = _get.apply(this, arguments);
|
|
// Convert result to an object (if last argument is an array, _get return already an object) and test each item
|
|
if (!$.isArray(a[l - 1])) {
|
|
v = {'totest': v};
|
|
}
|
|
for (var i in v) {
|
|
if (!(
|
|
($.isPlainObject(v[i]) && $.isEmptyObject(v[i])) ||
|
|
($.isArray(v[i]) && !v[i].length) ||
|
|
(!v[i])
|
|
)) {
|
|
return false;
|
|
}
|
|
}
|
|
return true;
|
|
} catch (e) {
|
|
return true;
|
|
}
|
|
}
|
|
}
|
|
|
|
// Check if items of a storage exist
|
|
function _isSet() {
|
|
var l = arguments.length, a = arguments, a0 = a[0];
|
|
if (l < 1) {
|
|
throw new Error('Minimum 1 argument must be given');
|
|
}
|
|
if ($.isArray(a0)) {
|
|
// If first argument is an array, test each item of this array and return true only if all items exist
|
|
for (var i = 0; i < a0.length; i++) {
|
|
if (!_isSet.call(this, a0[i])) {
|
|
return false;
|
|
}
|
|
}
|
|
return true;
|
|
} else {
|
|
// For other case, try to get value and test it
|
|
try {
|
|
var v = _get.apply(this, arguments);
|
|
// Convert result to an object (if last argument is an array, _get return already an object) and test each item
|
|
if (!$.isArray(a[l - 1])) {
|
|
v = {'totest': v};
|
|
}
|
|
for (var i in v) {
|
|
if (!(v[i] !== undefined && v[i] !== null)) {
|
|
return false;
|
|
}
|
|
}
|
|
return true;
|
|
} catch (e) {
|
|
return false;
|
|
}
|
|
}
|
|
}
|
|
|
|
// Get keys of a storage or of an item of the storage
|
|
function _keys() {
|
|
var storage = this._type, l = arguments.length, s = window[storage], a = arguments, keys = [], o = {};
|
|
// If at least 1 argument, get value from storage to retrieve keys
|
|
// Else, use storage to retrieve keys
|
|
if (l > 0) {
|
|
o = _get.apply(this, a);
|
|
} else {
|
|
o = s;
|
|
}
|
|
if (o && o._cookie) {
|
|
// If storage is a cookie, use js-cookie to retrieve keys
|
|
for (var key in Cookies.get()) {
|
|
if (key != '') {
|
|
keys.push(key.replace(o._prefix, ''));
|
|
}
|
|
}
|
|
} else {
|
|
for (var i in o) {
|
|
if (o.hasOwnProperty(i)) {
|
|
keys.push(i);
|
|
}
|
|
}
|
|
}
|
|
return keys;
|
|
}
|
|
|
|
// Create new namespace storage
|
|
function _createNamespace(name) {
|
|
if (!name || typeof name != "string") {
|
|
throw new Error('First parameter must be a string');
|
|
}
|
|
if (storage_available) {
|
|
if (!window.localStorage.getItem(name)) {
|
|
window.localStorage.setItem(name, '{}');
|
|
}
|
|
if (!window.sessionStorage.getItem(name)) {
|
|
window.sessionStorage.setItem(name, '{}');
|
|
}
|
|
} else {
|
|
if (!window.localCookieStorage.getItem(name)) {
|
|
window.localCookieStorage.setItem(name, '{}');
|
|
}
|
|
if (!window.sessionCookieStorage.getItem(name)) {
|
|
window.sessionCookieStorage.setItem(name, '{}');
|
|
}
|
|
}
|
|
var ns = {
|
|
localStorage: $.extend({}, $.localStorage, {_ns: name}),
|
|
sessionStorage: $.extend({}, $.sessionStorage, {_ns: name})
|
|
};
|
|
if (typeof Cookies !== 'undefined') {
|
|
if (!window.cookieStorage.getItem(name)) {
|
|
window.cookieStorage.setItem(name, '{}');
|
|
}
|
|
ns.cookieStorage = $.extend({}, $.cookieStorage, {_ns: name});
|
|
}
|
|
$.namespaceStorages[name] = ns;
|
|
return ns;
|
|
}
|
|
|
|
// Test if storage is natively available on browser
|
|
function _testStorage(name) {
|
|
var foo = 'jsapi';
|
|
try {
|
|
if (!window[name]) {
|
|
return false;
|
|
}
|
|
window[name].setItem(foo, foo);
|
|
window[name].removeItem(foo);
|
|
return true;
|
|
} catch (e) {
|
|
return false;
|
|
}
|
|
}
|
|
|
|
// Check if storages are natively available on browser
|
|
var storage_available = _testStorage('localStorage');
|
|
|
|
// Namespace object
|
|
var storage = {
|
|
_type: '',
|
|
_ns: '',
|
|
_callMethod: function (f, a) {
|
|
var p = [], a = Array.prototype.slice.call(a), a0 = a[0];
|
|
|
|
if (this._ns) {
|
|
p.push(this._ns);
|
|
}
|
|
if (typeof a0 === 'string' && a0.indexOf('.') !== -1) {
|
|
a.shift();
|
|
[].unshift.apply(a, a0.split('.'));
|
|
}
|
|
[].push.apply(p, a);
|
|
return f.apply(this, p);
|
|
},
|
|
// Define if plugin always use JSON to store values (even to store simple values like string, int...) or not
|
|
alwaysUseJson: false,
|
|
// Get items. If no parameters and storage have a namespace, return all namespace
|
|
get: function () {
|
|
return this._callMethod(_get, arguments);
|
|
},
|
|
// Set items
|
|
set: function () {
|
|
var l = arguments.length, a = arguments, a0 = a[0];
|
|
if (l < 1 || !$.isPlainObject(a0) && l < 2) {
|
|
throw new Error('Minimum 2 arguments must be given or first parameter must be an object');
|
|
}
|
|
// If first argument is an object and storage is a namespace storage, set values individually
|
|
if ($.isPlainObject(a0) && this._ns) {
|
|
for (var i in a0) {
|
|
this._callMethod(_set, [i, a0[i]]);
|
|
}
|
|
return a0;
|
|
} else {
|
|
var r = this._callMethod(_set, a);
|
|
if (this._ns) {
|
|
return r[a0.split('.')[0]];
|
|
} else {
|
|
return r;
|
|
}
|
|
}
|
|
},
|
|
// Delete items
|
|
remove: function () {
|
|
if (arguments.length < 1) {
|
|
throw new Error('Minimum 1 argument must be given');
|
|
}
|
|
return this._callMethod(_remove, arguments);
|
|
},
|
|
// Delete all items
|
|
removeAll: function (reinit_ns) {
|
|
if (this._ns) {
|
|
this._callMethod(_set, [{}]);
|
|
return true;
|
|
} else {
|
|
return this._callMethod(_removeAll, [reinit_ns]);
|
|
}
|
|
},
|
|
// Items empty
|
|
isEmpty: function () {
|
|
return this._callMethod(_isEmpty, arguments);
|
|
},
|
|
// Items exists
|
|
isSet: function () {
|
|
if (arguments.length < 1) {
|
|
throw new Error('Minimum 1 argument must be given');
|
|
}
|
|
return this._callMethod(_isSet, arguments);
|
|
},
|
|
// Get keys of items
|
|
keys: function () {
|
|
return this._callMethod(_keys, arguments);
|
|
}
|
|
};
|
|
|
|
// Use js-cookie for compatibility with old browsers and give access to cookieStorage
|
|
if (typeof Cookies !== 'undefined') {
|
|
// sessionStorage is valid for one window/tab. To simulate that with cookie, we set a name for the window and use it for the name of the cookie
|
|
if (!window.name) {
|
|
window.name = Math.floor(Math.random() * 100000000);
|
|
}
|
|
var cookie_storage = {
|
|
_cookie: true,
|
|
_prefix: '',
|
|
_expires: null,
|
|
_path: null,
|
|
_domain: null,
|
|
setItem: function (n, v) {
|
|
Cookies.set(this._prefix + n, v, {expires: this._expires, path: this._path, domain: this._domain});
|
|
},
|
|
getItem: function (n) {
|
|
return Cookies.get(this._prefix + n);
|
|
},
|
|
removeItem: function (n) {
|
|
return Cookies.remove(this._prefix + n, {path: this._path});
|
|
},
|
|
clear: function () {
|
|
for (var key in Cookies.get()) {
|
|
if (key != '') {
|
|
if (!this._prefix && key.indexOf(cookie_local_prefix) === -1 && key.indexOf(cookie_session_prefix) === -1 || this._prefix && key.indexOf(this._prefix) === 0) {
|
|
Cookies.remove(key);
|
|
}
|
|
}
|
|
}
|
|
},
|
|
setExpires: function (e) {
|
|
this._expires = e;
|
|
return this;
|
|
},
|
|
setPath: function (p) {
|
|
this._path = p;
|
|
return this;
|
|
},
|
|
setDomain: function (d) {
|
|
this._domain = d;
|
|
return this;
|
|
},
|
|
setConf: function (c) {
|
|
if (c.path) {
|
|
this._path = c.path;
|
|
}
|
|
if (c.domain) {
|
|
this._domain = c.domain;
|
|
}
|
|
if (c.expires) {
|
|
this._expires = c.expires;
|
|
}
|
|
return this;
|
|
},
|
|
setDefaultConf: function () {
|
|
this._path = this._domain = this._expires = null;
|
|
}
|
|
};
|
|
if (!storage_available) {
|
|
window.localCookieStorage = $.extend({}, cookie_storage, {
|
|
_prefix: cookie_local_prefix,
|
|
_expires: 365 * 10
|
|
});
|
|
window.sessionCookieStorage = $.extend({}, cookie_storage, {_prefix: cookie_session_prefix + window.name + '_'});
|
|
}
|
|
window.cookieStorage = $.extend({}, cookie_storage);
|
|
// cookieStorage API
|
|
$.cookieStorage = $.extend({}, storage, {
|
|
_type: 'cookieStorage',
|
|
setExpires: function (e) {
|
|
window.cookieStorage.setExpires(e);
|
|
return this;
|
|
},
|
|
setPath: function (p) {
|
|
window.cookieStorage.setPath(p);
|
|
return this;
|
|
},
|
|
setDomain: function (d) {
|
|
window.cookieStorage.setDomain(d);
|
|
return this;
|
|
},
|
|
setConf: function (c) {
|
|
window.cookieStorage.setConf(c);
|
|
return this;
|
|
},
|
|
setDefaultConf: function () {
|
|
window.cookieStorage.setDefaultConf();
|
|
return this;
|
|
}
|
|
});
|
|
}
|
|
|
|
// Get a new API on a namespace
|
|
$.initNamespaceStorage = function (ns) {
|
|
return _createNamespace(ns);
|
|
};
|
|
if (storage_available) {
|
|
// About alwaysUseJson
|
|
// By default, all values are string on html storages and the plugin don't use json to store simple values (strings, int, float...)
|
|
// So by default, if you do storage.setItem('test',2), value in storage will be "2", not 2
|
|
// If you set this property to true, all values set with the plugin will be stored as json to have typed values in any cases
|
|
|
|
// localStorage API
|
|
$.localStorage = $.extend({}, storage, {_type: 'localStorage'});
|
|
// sessionStorage API
|
|
$.sessionStorage = $.extend({}, storage, {_type: 'sessionStorage'});
|
|
} else {
|
|
// localStorage API
|
|
$.localStorage = $.extend({}, storage, {_type: 'localCookieStorage'});
|
|
// sessionStorage API
|
|
$.sessionStorage = $.extend({}, storage, {_type: 'sessionCookieStorage'});
|
|
}
|
|
// List of all namespace storage
|
|
$.namespaceStorages = {};
|
|
// Remove all items in all storages
|
|
$.removeAllStorages = function (reinit_ns) {
|
|
$.localStorage.removeAll(reinit_ns);
|
|
$.sessionStorage.removeAll(reinit_ns);
|
|
if ($.cookieStorage) {
|
|
$.cookieStorage.removeAll(reinit_ns);
|
|
}
|
|
if (!reinit_ns) {
|
|
$.namespaceStorages = {};
|
|
}
|
|
}
|
|
$.alwaysUseJsonInStorage = function (value) {
|
|
storage.alwaysUseJson = value;
|
|
$.localStorage.alwaysUseJson = value;
|
|
$.sessionStorage.alwaysUseJson = value;
|
|
if ($.cookieStorage) {
|
|
$.cookieStorage.alwaysUseJson = value;
|
|
}
|
|
}
|
|
}));
|