mirror_php/moodle
1
0
Fork 0
mirror of https://github.com/moodle/moodle.git synced 2025-04-25 10:26:17 +02:00
Code Issues Projects Releases Wiki Activity

MDL-57975 javascript: add sessionstorage.js

Browse Source 
Part of MDL-55611
This commit is contained in:
Ryan Wyllie 2017-02-22 02:33:39 +00:00
parent 3c45d26f58
commit b6563dcfc3
6 changed files with 234 additions and 132 deletions

2
lib/amd/build/localstorage.min.js vendored

@ -1 +1 @@
define(["core/config"],function(a){var b=!1,c="",d="",e=null,f=function(){if(a.jsrev==-1)return!1;if("undefined"==typeof window.localStorage)return!1;var b="test";try{return e=window.localStorage,null!==e&&(e.setItem(b,"1"),e.removeItem(b),!0)}catch(c){return!1}},g=function(a){return c+a},h=function(){var b=e.getItem(d);if(null===b)return void e.setItem(d,a.jsrev);var c=a.jsrev;c!=b&&(e.clear(),e.setItem(d,a.jsrev))},i=function(a){var b,c,d,e=0;if(0===a.length)return e;for(b=0,d=a.length;b<d;b++)c=a.charCodeAt(b),e=(e<<5)-e+c,e|=0;return e},j=function(){b=f();var e=a.wwwroot+"/"+a.jsrev,g=i(e);c=g+"/",e=a.wwwroot+"/",g=i(e),d=g+"/jsrev"};return j(),{get:function(a){return!!b&&(h(),a=g(a),e.getItem(a))},set:function(a,c){if(!b)return!1;h(),a=g(a);try{e.setItem(a,c)}catch(d){return!1}return!0}}});
define(["core/config","core/storagewrapper"],function(a,b){var c=new b(window.localStorage);return{get:function(a){return c.get(a)},set:function(a,b){return c.set(a,b)}}});

1
lib/amd/build/sessionstorage.min.js vendored Normal file

@ -0,0 +1 @@
define(["core/config","core/storagewrapper"],function(a,b){var c=new b(window.sessionStorage);return{get:function(a){return c.get(a)},set:function(a,b){return c.set(a,b)}}});

1
lib/amd/build/storagewrapper.min.js vendored Normal file

@ -0,0 +1 @@
define(["core/config"],function(a){var b=function(b){this.storage=b,this.supported=this.detectSupport(),this.hashSource=a.wwwroot+"/"+a.jsrev,this.hash=this.hashString(this.hashSource),this.prefix=this.hash+"/",this.jsrevPrefix=this.hash+"/jsrev"};return b.prototype.detectSupport=function(){if(a.jsrev==-1)return!1;if("undefined"==typeof this.storage)return!1;var b="test";try{return null!==this.storage&&(this.storage.setItem(b,"1"),this.storage.removeItem(b),!0)}catch(c){return!1}},b.prototype.prefixKey=function(a){return this.prefix+a},b.prototype.validateCache=function(){var b=this.storage.getItem(this.jsrevPrefix);if(null===b)return void this.storage.setItem(this.jsrevPrefix,a.jsrev);var c=a.jsrev;c!=b&&(this.storage.clear(),this.storage.setItem(this.jsrevPrefix,a.jsrev))},b.prototype.hashString=function(a){var b,c,d,e=0;if(0===a.length)return e;for(b=0,d=a.length;b<d;b++)c=a.charCodeAt(b),e=(e<<5)-e+c,e|=0;return e},b.prototype.get=function(a){return!!this.supported&&(this.validateCache(),a=this.prefixKey(a),this.storage.getItem(a))},b.prototype.set=function(a,b){if(!this.supported)return!1;this.validateCache(),a=this.prefixKey(a);try{this.storage.setItem(a,b)}catch(c){return!1}return!0},b});

136
lib/amd/src/localstorage.js

@ -23,120 +23,11 @@
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @since 2.9
*/
define(['core/config'], function(config) {
define(['core/config', 'core/storagewrapper'], function(config, StorageWrapper) {
// Private functions and variables.
/** @var {boolean} supported - Is localstorage supported in this browser? */
var supported = false;
/** @var {string} prefix - Prefix to use on all cache keys */
var prefix = '';
/** @var {jsrevPrefix} jsrevPrefix - Key to store the current jsrev version for the cache */
var jsrevPrefix = '';
/** @var {Object} localStorage - Browsers localStorage object */
var localStorage = null;
/**
* Check if the browser supports local storage.
*
* @method detectSupport
* @return {boolean} True if the browser supports local storage.
*/
var detectSupport = function() {
if (config.jsrev == -1) {
// Disable cache if debugging.
return false;
}
if (typeof (window.localStorage) === "undefined") {
return false;
}
var testKey = 'test';
try {
localStorage = window.localStorage;
if (localStorage === null) {
return false;
}
// MDL-51461 - Some browsers misreport availability of local storage
// so check it is actually usable.
localStorage.setItem(testKey, '1');
localStorage.removeItem(testKey);
return true;
} catch (ex) {
return false;
}
};
/**
* Add a unique prefix to all keys so multiple moodle sites do not share caches.
*
* @method prefixKey
* @param {string} key The cache key to prefix.
* @return {string} The new key
*/
var prefixKey = function(key) {
return prefix + key;
};
/**
* Check the current jsrev version and clear the cache if it has been bumped.
*
* @method validateCache
*/
var validateCache = function() {
var cacheVersion = localStorage.getItem(jsrevPrefix);
if (cacheVersion === null) {
localStorage.setItem(jsrevPrefix, config.jsrev);
return;
}
var moodleVersion = config.jsrev;
if (moodleVersion != cacheVersion) {
localStorage.clear();
localStorage.setItem(jsrevPrefix, config.jsrev);
}
};
/**
* Hash a string, used to make shorter key prefixes.
*
* @method hashString
* @param {String} source The string to hash
* @return {Number}
*/
var hashString = function(source) {
// From http://stackoverflow.com/questions/7616461/generate-a-hash-from-string-in-javascript-jquery.
/* jshint bitwise: false */
/* eslint no-bitwise: "off" */
var hash = 0;
var i, chr, len;
if (source.length === 0) {
return hash;
}
for (i = 0, len = source.length; i < len; i++) {
chr = source.charCodeAt(i);
hash = ((hash << 5) - hash) + chr;
hash |= 0; // Convert to 32bit integer
}
return hash;
};
/**
* Init this module.
*
* This computes the hash prefixes from jsrev and friends.
*/
var init = function() {
supported = detectSupport();
var hashSource = config.wwwroot + '/' + config.jsrev;
var hash = hashString(hashSource);
prefix = hash + '/';
hashSource = config.wwwroot + '/';
hash = hashString(hashSource);
jsrevPrefix = hash + '/jsrev';
};
// Run the module init.
init();
/** @var {Object} StorageWrapper - Wraps browsers localStorage object */
var storage = new StorageWrapper(window.localStorage);
return /** @alias module:core/localstorage */ {
/**
@ -147,13 +38,7 @@ define(['core/config'], function(config) {
* @return {boolean|string} False if the value is not in the cache, or some other error - a string otherwise.
*/
get: function(key) {
if (!supported) {
return false;
}
validateCache();
key = prefixKey(key);
return localStorage.getItem(key);
return storage.get(key);
},
/**
@ -165,18 +50,7 @@ define(['core/config'], function(config) {
* @return {boolean} False if the value can't be saved in the cache, or some other error - true otherwise.
*/
set: function(key, value) {
if (!supported) {
return false;
}
validateCache();
key = prefixKey(key);
// This can throw exceptions when the storage limit is reached.
try {
localStorage.setItem(key, value);
} catch (e) {
return false;
}
return true;
return storage.set(key, value);
}
};

61
lib/amd/src/sessionstorage.js Normal file

@ -0,0 +1,61 @@
// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
/**
* Simple API for set/get to sessionstorage, with cacherev expiration.
*
* Session storage will only persist for as long as the browser window
* stays open.
*
* See:
* https://developer.mozilla.org/en-US/docs/Web/API/Window/sessionStorage
*
* @module core/sessionstorage
* @package core
* @copyright 2017 Ryan Wyllie <ryan@moodle.com>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
define(['core/config', 'core/storagewrapper'], function(config, StorageWrapper) {
// Private functions and variables.
/** @var {Object} StorageWrapper - Wraps browsers sessionStorage object */
var storage = new StorageWrapper(window.sessionStorage);
return /** @alias module:core/sessionstorage */ {
/**
* Get a value from session storage. Remember - all values must be strings.
*
* @method get
* @param {string} key The cache key to check.
* @return {boolean|string} False if the value is not in the cache, or some other error - a string otherwise.
*/
get: function(key) {
return storage.get(key);
},
/**
* Set a value to session storage. Remember - all values must be strings.
*
* @method set
* @param {string} key The cache key to set.
* @param {string} value The value to set.
* @return {boolean} False if the value can't be saved in the cache, or some other error - true otherwise.
*/
set: function(key, value) {
return storage.set(key, value);
}
};
});

165
lib/amd/src/storagewrapper.js Normal file

@ -0,0 +1,165 @@
// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
/**
* Wrap an instance of the browser's local or session storage to handle
* cache expiry, key namespacing and other helpful things.
*
* @module core/storagewrapper
* @package core
* @copyright 2017 Ryan Wyllie <ryan@moodle.com>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
define(['core/config'], function(config) {
/**
* Constructor.
*
* @param {object} storage window.localStorage or window.sessionStorage
*/
var Wrapper = function(storage) {
this.storage = storage;
this.supported = this.detectSupport();
this.hashSource = config.wwwroot + '/' + config.jsrev;
this.hash = this.hashString(this.hashSource);
this.prefix = this.hash + '/';
this.jsrevPrefix = this.hash + '/jsrev';
};
/**
* Check if the browser supports the type of storage.
*
* @method detectSupport
* @return {boolean} True if the browser supports storage.
*/
Wrapper.prototype.detectSupport = function() {
if (config.jsrev == -1) {
// Disable cache if debugging.
return false;
}
if (typeof (this.storage) === "undefined") {
return false;
}
var testKey = 'test';
try {
if (this.storage === null) {
return false;
}
// MDL-51461 - Some browsers misreport availability of the storage
// so check it is actually usable.
this.storage.setItem(testKey, '1');
this.storage.removeItem(testKey);
return true;
} catch (ex) {
return false;
}
};
/**
* Add a unique prefix to all keys so multiple moodle sites do not share caches.
*
* @method prefixKey
* @param {string} key The cache key to prefix.
* @return {string} The new key
*/
Wrapper.prototype.prefixKey = function(key) {
return this.prefix + key;
};
/**
* Check the current jsrev version and clear the cache if it has been bumped.
*
* @method validateCache
*/
Wrapper.prototype.validateCache = function() {
var cacheVersion = this.storage.getItem(this.jsrevPrefix);
if (cacheVersion === null) {
this.storage.setItem(this.jsrevPrefix, config.jsrev);
return;
}
var moodleVersion = config.jsrev;
if (moodleVersion != cacheVersion) {
this.storage.clear();
this.storage.setItem(this.jsrevPrefix, config.jsrev);
}
};
/**
* Hash a string, used to make shorter key prefixes.
*
* @method hashString
* @param {String} source The string to hash
* @return {Number}
*/
Wrapper.prototype.hashString = function(source) {
// From http://stackoverflow.com/questions/7616461/generate-a-hash-from-string-in-javascript-jquery.
/* jshint bitwise: false */
/* eslint no-bitwise: "off" */
var hash = 0;
var i, chr, len;
if (source.length === 0) {
return hash;
}
for (i = 0, len = source.length; i < len; i++) {
chr = source.charCodeAt(i);
hash = ((hash << 5) - hash) + chr;
hash |= 0; // Convert to 32bit integer
}
return hash;
};
/**
* Get a value from local storage. Remember - all values must be strings.
*
* @method get
* @param {string} key The cache key to check.
* @return {boolean|string} False if the value is not in the cache, or some other error - a string otherwise.
*/
Wrapper.prototype.get = function(key) {
if (!this.supported) {
return false;
}
this.validateCache();
key = this.prefixKey(key);
return this.storage.getItem(key);
};
/**
* Set a value to local storage. Remember - all values must be strings.
*
* @method set
* @param {string} key The cache key to set.
* @param {string} value The value to set.
* @return {boolean} False if the value can't be saved in the cache, or some other error - true otherwise.
*/
Wrapper.prototype.set = function(key, value) {
if (!this.supported) {
return false;
}
this.validateCache();
key = this.prefixKey(key);
// This can throw exceptions when the storage limit is reached.
try {
this.storage.setItem(key, value);
} catch (e) {
return false;
}
return true;
};
return Wrapper;
});