☰

GreaseMonkey_SuperValues

Extends the GM_setValue and GM_getValue functions for any javascript variable type.

当前为 2014-09-24 提交的版本，查看 最新版本。

此脚本不应直接安装。它是供其他脚本使用的外部库，要使用该库请加入元指令 // @require https://update.cn-greasyfork.org/scripts/5279/18760/GreaseMonkey_SuperValues.js 

  1. /***************************************************************************************
  2. ****************************************************************************************
  3. *****   Super GM_setValue and GM_getValue.js
  4. *****
  5. *****   This library extends the Greasemonkey GM_setValue and GM_getValue functions to
  6. *****   handle any javascript variable type.
  7. *****
  8. *****   Usage:
  9. *****       GM_SuperValue.set           (varName, varValue);
  10. *****       var x = GM_SuperValue.get   (varName, defaultValue);
  11. *****
  12. *****   Test mode:
  13. *****       GM_SuperValue.runTestCases  (bUseConsole);
  14. *****
  15. */
  16. // ==UserScript==
  17. // @name            GreaseMonkey_SuperValues
  18. // @description     Extends the GM_setValue and GM_getValue functions for any javascript variable type.
  19. // @namespace       Super_GM_setValue_and_Super_GM_getValue
  20. // @include         *
  21. // @version         1.1
  22. // @grant	    GM_getValue
  23. // @grant	    GM_setValue
  24. // ==/UserScript==
  25.  
  26. var GM_SuperValue = new function() {
  27.  
  28.     var JSON_MarkerStr = 'json_val: ';
  29.     var FunctionMarker = 'function_code: ';
  30.  
  31.     function ReportError(msg) {
  32.         if (console && console.error)
  33.             console.error(msg);
  34.         else
  35.             throw new Error(msg);
  36.     }
  37.  
  38.     //--- Check that the environment is proper.
  39.     if (typeof GM_setValue != "function")
  40.         ReportError('This library requires Greasemonkey! GM_setValue is missing.');
  41.     if (typeof GM_getValue != "function")
  42.         ReportError('This library requires Greasemonkey! GM_getValue is missing.');
  43.  
  44.  
  45.     /*--- set ()
  46.         GM_setValue (http://wiki.greasespot.net/GM_setValue) only stores:
  47.         strings, booleans, and integers (a limitation of using Firefox
  48.         preferences for storage).
  49.  
  50.         This function extends that to allow storing any data type.
  51.  
  52.         Parameters:
  53.             varName
  54.                 String: The unique (within this script) name for this value.
  55.                 Should be restricted to valid Javascript identifier characters.
  56.             varValue
  57.                 Any valid javascript value.  Just note that it is not advisable to
  58.                 store too much data in the Firefox preferences.
  59.  
  60.         Returns:
  61.             undefined
  62.     */
  63.     this.set = function(varName, varValue) {
  64.  
  65.         if (! varName) {
  66.             ReportError('Illegal varName sent to GM_SuperValue.set().');
  67.             return;
  68.         }
  69.         if (/[^\w _-]/.test(varName)) {
  70.             ReportError('Suspect, probably illegal, varName sent to GM_SuperValue.set().');
  71.         }
  72.  
  73.         switch (typeof varValue) {
  74.         case 'undefined':
  75.             ReportError('Illegal varValue sent to GM_SuperValue.set().');
  76.             break;
  77.         case 'boolean':
  78.         case 'string':
  79.             //--- These 2 types are safe to store, as is.
  80.             GM_setValue(varName, varValue);
  81.             break;
  82.         case 'number':
  83.             /*--- Numbers are ONLY safe if they are integers.
  84.                     Note that hex numbers, EG 0xA9, get converted
  85.                     and stored as decimals, EG 169, automatically.
  86.                     That's a feature of JavaScript.
  87.  
  88.                     Also, only a 32-bit, signed integer is allowed.
  89.                     So we only process +/-2147483647 here.
  90.                 */
  91.             if (varValue === parseInt(varValue) && Math.abs(varValue) < 2147483647) {
  92.                 GM_setValue(varName, varValue);
  93.                 break;
  94.             }
  95.         case 'object':
  96.             /*--- For all other cases (but functions), and for
  97.                     unsafe numbers, store the value as a JSON string.
  98.                 */
  99.             var safeStr = JSON_MarkerStr + JSON.stringify(varValue);
  100.             GM_setValue(varName, safeStr);
  101.             break;
  102.         case 'function':
  103.             /*--- Functions need special handling.
  104.                 */
  105.             var safeStr = FunctionMarker + varValue.toString();
  106.             GM_setValue(varName, safeStr);
  107.             break;
  108.  
  109.         default:
  110.             ReportError('Unknown type in GM_SuperValue.set()!');
  111.             break;
  112.         }
  113.     } //-- End of set()
  114.  
  115.  
  116.     /*--- get ()
  117.         GM_getValue (http://wiki.greasespot.net/GM_getValue) only retieves:
  118.         strings, booleans, and integers (a limitation of using Firefox
  119.         preferences for storage).
  120.  
  121.         This function extends that to allow retrieving any data type -- as
  122.         long as it was stored with GM_SuperValue.set().
  123.  
  124.         Parameters:
  125.             varName
  126.                 String: The property name to get. See GM_SuperValue.set for details.
  127.             defaultValue
  128.                 Optional. Any value to be returned, when no value has previously
  129.                 been set.
  130.  
  131.         Returns:
  132.             When this name has been set...
  133.                 The variable or function value as previously set.
  134.  
  135.             When this name has not been set, and a default is provided...
  136.                 The value passed in as a default
  137.  
  138.             When this name has not been set, and default is not provided...
  139.                 undefined
  140.     */
  141.     this.get = function(varName, defaultValue) {
  142.  
  143.         if (! varName) {
  144.             ReportError('Illegal varName sent to GM_SuperValue.get().');
  145.             return;
  146.         }
  147.         if (/[^\w _-]/.test(varName)) {
  148.             ReportError('Suspect, probably illegal, varName sent to GM_SuperValue.get().');
  149.         }
  150.  
  151.         //--- Attempt to get the value from storage.
  152.         var varValue = GM_getValue(varName);
  153.         if (!varValue)
  154.             return defaultValue;
  155.  
  156.         //--- We got a value from storage. Now unencode it, if necessary.
  157.         if (typeof varValue == "string") {
  158.             //--- Is it a JSON value?
  159.             var regxp = new RegExp('^' + JSON_MarkerStr + '(.+)$');
  160.             var m = varValue.match(regxp);
  161.             if (m && m.length > 1) {
  162.                 varValue = JSON.parse(m[1]);
  163.                 return varValue;
  164.             }
  165.  
  166.             //--- Is it a function?
  167.             var regxp = new RegExp('^' + FunctionMarker + '((?:.|\n|\r)+)$');
  168.             var m = varValue.match(regxp);
  169.             if (m && m.length > 1) {
  170.                 varValue = eval('(' + m[1] + ')');
  171.                 return varValue;
  172.             }
  173.         }
  174.  
  175.         return varValue;
  176.     } //-- End of get()
  177.  
  178.     this.runTestCases = function() {
  179.  
  180.         this.testCase(true);        // boolean
  181.         this.testCase(0);           // integers
  182.         this.testCase(!0);          // boolean
  183.         this.testCase(3.14);        // unsafe numbers
  184.         this.testCase("testCase");  // simple strings
  185.         this.testCase(void 0);      // undefined
  186.         this.testCase({
  187.             test: "test1"
  188.         });                         // object
  189.         this.testCase(function() {
  190.             // do nothing...
  191.         });                         // function
  192.         this.testCase({
  193.             text: "hello",
  194.             inner: {
  195.                 iTest1: "iTest1",
  196.                 iTest2: "iTest2"
  197.             },
  198.             fn: function() {
  199.                 return this.text;
  200.             },
  201.         });                         // composite object
  202.  
  203.     }
  204.  
  205.     this.testCase = function(testVar) {
  206.  
  207.         try {
  208.  
  209.             console.log("testing " + typeof (testVar) + " with: " + testVar);
  210.             GM_SuperValue.set("testVar", testVar);
  211.             console.log("saved...");
  212.             var newVar = GM_SuperValue.get("newVar", testVar);
  213.             console.log("retrieved " + typeof (newVar) + " with: " + newVar);
  214.             console.log("test case passed: ", newVar === testVar);
  215.  
  216.         } catch (e) {
  217.             console.error("test case failed: " + e);
  218.         }         
  219.     }
  220. }