Extends the GM_setValue and GM_getValue functions for any javascript variable type.
This script should not be not be installed directly. It is a library for other scripts to include with the meta directive // @require https://update.greasyfork.org/scripts/622/1786/Super_GM_setValue_and_GM_getValuejs.js
/***************************************************************************************
****************************************************************************************
***** Super GM_setValue and GM_getValue.js
*****
***** This library extends the Greasemonkey GM_setValue and GM_getValue functions to
***** handle any javascript variable type.
*****
***** Add it to your GM script with:
***** // @require http://userscripts.org/scripts/source/107941.user.js
*****
*****
***** Usage:
***** GM_SuperValue.set (varName, varValue);
***** var x = GM_SuperValue.get (varName, defaultValue);
*****
***** Test mode:
***** GM_SuperValue.runTestCases (bUseConsole);
*****
*/
// ==UserScript==
// @name Super_GM_setValue_and_GM_getValue.js
// @description Extends the GM_setValue and GM_getValue functions for any javascript variable type.
// @namespace userscripts.org/users/158640
// @version 1
// ==/UserScript==
var GM_SuperValue = new function () {
var JSON_MarkerStr = 'json_val: ';
var FunctionMarker = 'function_code: ';
function ReportError (msg) {
if (console && console.error)
console.log (msg);
else
throw new Error (msg);
}
//--- Check that the environment is proper.
if (typeof GM_setValue != "function")
ReportError ('This library requires Greasemonkey! GM_setValue is missing.');
if (typeof GM_getValue != "function")
ReportError ('This library requires Greasemonkey! GM_getValue is missing.');
/*--- set ()
GM_setValue (http://wiki.greasespot.net/GM_setValue) only stores:
strings, booleans, and integers (a limitation of using Firefox
preferences for storage).
This function extends that to allow storing any data type.
Parameters:
varName
String: The unique (within this script) name for this value.
Should be restricted to valid Javascript identifier characters.
varValue
Any valid javascript value. Just note that it is not advisable to
store too much data in the Firefox preferences.
Returns:
undefined
*/
this.set = function (varName, varValue) {
if ( ! varName) {
ReportError ('Illegal varName sent to GM_SuperValue.set().');
return;
}
if (/[^\w _-]/.test (varName) ) {
ReportError ('Suspect, probably illegal, varName sent to GM_SuperValue.set().');
}
switch (typeof varValue) {
case 'undefined':
ReportError ('Illegal varValue sent to GM_SuperValue.set().');
break;
case 'boolean':
case 'string':
//--- These 2 types are safe to store, as is.
GM_setValue (varName, varValue);
break;
case 'number':
/*--- Numbers are ONLY safe if they are integers.
Note that hex numbers, EG 0xA9, get converted
and stored as decimals, EG 169, automatically.
That's a feature of JavaScript.
Also, only a 32-bit, signed integer is allowed.
So we only process +/-2147483647 here.
*/
if (varValue === parseInt (varValue) && Math.abs (varValue) < 2147483647)
{
GM_setValue (varName, varValue);
break;
}
case 'object':
/*--- For all other cases (but functions), and for
unsafe numbers, store the value as a JSON string.
*/
var safeStr = JSON_MarkerStr + JSON.stringify (varValue);
GM_setValue (varName, safeStr);
break;
case 'function':
/*--- Functions need special handling.
*/
var safeStr = FunctionMarker + varValue.toString ();
GM_setValue (varName, safeStr);
break;
default:
ReportError ('Unknown type in GM_SuperValue.set()!');
break;
}
}//-- End of set()
/*--- get ()
GM_getValue (http://wiki.greasespot.net/GM_getValue) only retieves:
strings, booleans, and integers (a limitation of using Firefox
preferences for storage).
This function extends that to allow retrieving any data type -- as
long as it was stored with GM_SuperValue.set().
Parameters:
varName
String: The property name to get. See GM_SuperValue.set for details.
defaultValue
Optional. Any value to be returned, when no value has previously
been set.
Returns:
When this name has been set...
The variable or function value as previously set.
When this name has not been set, and a default is provided...
The value passed in as a default
When this name has not been set, and default is not provided...
undefined
*/
this.get = function (varName, defaultValue) {
if ( ! varName) {
ReportError ('Illegal varName sent to GM_SuperValue.get().');
return;
}
if (/[^\w _-]/.test (varName) ) {
ReportError ('Suspect, probably illegal, varName sent to GM_SuperValue.get().');
}
//--- Attempt to get the value from storage.
var varValue = GM_getValue (varName);
if (!varValue)
return defaultValue;
//--- We got a value from storage. Now unencode it, if necessary.
if (typeof varValue == "string") {
//--- Is it a JSON value?
var regxp = new RegExp ('^' + JSON_MarkerStr + '(.+)$');
var m = varValue.match (regxp);
if (m && m.length > 1) {
varValue = JSON.parse ( m[1] );
return varValue;
}
//--- Is it a function?
var regxp = new RegExp ('^' + FunctionMarker + '((?:.|\n|\r)+)$');
var m = varValue.match (regxp);
if (m && m.length > 1) {
varValue = eval ('(' + m[1] + ')');
return varValue;
}
}
return varValue;
}//-- End of get()
/*--- runTestCases ()
Tests storage and retrieval every every knid of value.
Note: makes extensive use of the console.
Parameters:
bUseConsole
Boolean: If this is true, uses the console environment to store
the data. Useful for dev test.
Returns:
true, if pass. false, otherwise.
*/
this.runTestCases = function (bUseConsole) {
if (bUseConsole) {
//--- Set up the environment to use local JS, and not the GM environment.
this.testStorage = {};
var context = this;
this.oldSetFunc = (typeof GM_setValue == "function") ? GM_setValue : null;
this.oldGetFunc = (typeof GM_getValue == "function") ? GM_getValue : null;
GM_setValue = function (varName, varValue) {
console.log ('Storing: ', varName, ' as: ', varValue);
context.testStorage[varName] = varValue;
}
GM_getValue = function (varName, defaultValue) {
var varValue = context.testStorage[varName];
if (!varValue)
varValue = defaultValue;
console.log ('Retrieving: ', varName, '. Got: ', varValue);
return varValue;
}
}
var dataBefore = [null, true, 1, 1.1, -1.0, 2.0E9, 2.77E9, 2.0E-9, 0xA9, 'string',
[1,2,3], {a:1, B:2}, function () {a=7; console.log ("Neat! Ain't it?"); }
];
for (var J = 0; J <= dataBefore.length; J++)
{
var X = dataBefore[J];
console.log (J, ': ', typeof X, X);
this.set ('Test item ' + J, X);
console.log ('\n');
}
console.log ('\n***********************\n***********************\n\n');
var dataAfter = [];
for (var J = 0; J < dataBefore.length; J++)
{
var X = this.get ('Test item ' + J);
dataAfter.push (X);
console.log ('\n');
}
console.log (dataBefore);
console.log (dataAfter);
dataAfter[12]();
//--- Now test for pass/fail. The objects won't be identical but contenets are.
var bPass;
if (dataBefore.toString() == dataAfter.toString() ) {
var pfStr = 'PASS!';
bPass = true;
} else {
var pfStr = 'FAIL!';
bPass = false;
}
console.log ( "\n*************************** \
\n*************************** \
\n*************************** \
\n***** " + pfStr + " ***** \
\n*************************** \
\n*************************** \
\n***************************\n");
if (bUseConsole) {
//--- Restore the GM functions.
GM_setValue = this.oldSetFunc;
GM_getValue = this.oldGetFunc;
}
else {
//--- Clean up the FF storage!
for (var J = 0; J < dataBefore.length; J++)
{
GM_deleteValue ('Test item ' + J);
}
}
return bPass;
}//-- End of runTestCases()
};
//GM_SuperValue.runTestCases (true);
//--- EOF