From 54a17f303e9ba559f3c9ca872f2077b34bf0033d Mon Sep 17 00:00:00 2001
From: ketmar <ketmar@ketmar.no-ip.org>
Date: Wed, 12 Aug 2015 01:00:00 +0000
Subject: [PATCH] universal preferences engine

FossilOrigin-Name: 1240fc3bc930e49db005f0556f34feb509c263b30f6df7a7a9c8ead62d04f096
---
 chrome/guerilla-overlay.js        | 11 ++++----
 chrome/guerilla-overlay.xul       | 30 ++++++++++----------
 main/init.js                      | 20 +++++++------
 main/main.js                      |  2 +-
 main/prefs/prefs.js               | 35 +++++++++++++++++++++++
 main/{prefs.js => prefsengine.js} | 59 +++++++++++----------------------------
 6 files changed, 85 insertions(+), 72 deletions(-)
 rewrite chrome/guerilla-overlay.xul (68%)
 create mode 100644 main/prefs/prefs.js
 rename main/{prefs.js => prefsengine.js} (77%)

diff --git a/chrome/guerilla-overlay.js b/chrome/guerilla-overlay.js
index cae3548..ce51cfc 100644
--- a/chrome/guerilla-overlay.js
+++ b/chrome/guerilla-overlay.js
@@ -10,10 +10,10 @@
 ////////////////////////////////////////////////////////////////////////////////
 // all our code will live in this nice closure
 (function (global) {
-  window.addEventListener("load", function () {
-    const {utils:Cu, classes:Cc, interfaces:Ci, results:Cr} = Components;
+  global.window.addEventListener("load", function () {
+    const {utils:Cu, classes:Cc, interfaces:Ci, results:Cr} = global.Components;
 
-    // load "main/init.js"
+    // load "mainjs:init.js"
     let uri = Cc["@mozilla.org/network/io-service;1"].getService(Ci.nsIIOService).newURI("chrome://guerilla-script-jscode/content/init.js", null, null);
     let initfn = Cc["@mozilla.org/moz/jssubscript-loader;1"].getService(Ci.mozIJSSubScriptLoader).loadSubScript(uri.spec, this, "UTF-8");
     try {
@@ -24,11 +24,12 @@
       );
       if (!addonobj) return; // alas, something is wrong
       // add "isBootstrapped" flag
-      //const isBootstrapped = ("__SCRIPT_URI_SPEC__" in this);
       addonobj.defProp("isBootstrapped", {get: function () false});
       // add more URLs
       addonobj.defProp("gsdoxURL", {get: function () "chrome://guerilla-script-dox/content/"});
-      window.addEventListener("unload", function () { addonobj.onShutdown(); }, false);
+      // setup shutdown hook
+      global.window.addEventListener("unload", function () { addonobj.onShutdown(); }, false);
+      // initialize subsystems
       addonobj.onStartup();
     } catch (e) {
       Components.utils.reportError(e.stack);
diff --git a/chrome/guerilla-overlay.xul b/chrome/guerilla-overlay.xul
dissimilarity index 68%
index e8d1775..f1a0539 100644
--- a/chrome/guerilla-overlay.xul
+++ b/chrome/guerilla-overlay.xul
@@ -1,16 +1,14 @@
-<?xml version="1.0"?>
-<!-- ***** BEGIN LICENSE BLOCK *****
- * coded by Ketmar // Invisible Vector (psyc://ketmar.no-ip.org/~Ketmar)
- * Understanding is not required. Only obedience.
- *
- * This program is free software. It comes without any warranty, to
- * the extent permitted by applicable law. You can redistribute it
- * and/or modify it under the terms of the Do What The Fuck You Want
- * To Public License, Version 2, as published by Sam Hocevar. See
- * http://www.wtfpl.net/txt/copying/ for more details.
- *
-   - ***** END LICENSE BLOCK ***** -->
-<overlay xmlns="http://www.mozilla.org/keymaster/gatekeeper/there.is.only.xul"
-         id="guerillaScriptOverlay">
- <script src="guerilla-overlay.js"/>
-</overlay>
\ No newline at end of file
+<?xml version="1.0"?>
+<!-- ***** BEGIN LICENSE BLOCK *****
+   coded by Ketmar // Invisible Vector (psyc://ketmar.no-ip.org/~Ketmar)
+   Understanding is not required. Only obedience.
+
+   This program is free software. It comes without any warranty, to
+   the extent permitted by applicable law. You can redistribute it
+   and/or modify it under the terms of the Do What The Fuck You Want
+   To Public License, Version 2, as published by Sam Hocevar. See
+   http://www.wtfpl.net/txt/copying/ for more details.
+   - ***** END LICENSE BLOCK ***** -->
+<overlay xmlns="http://www.mozilla.org/keymaster/gatekeeper/there.is.only.xul">
+ <script src="guerilla-overlay.js"/>
+</overlay>
\ No newline at end of file
diff --git a/main/init.js b/main/init.js
index 9c89a28..b63ff1a 100644
--- a/main/init.js
+++ b/main/init.js
@@ -49,14 +49,17 @@
     }
   }
 
-  //TODO: add "XMLHttpRequest" for xpcshell
-
   // add some common API
-  Object.defineProperty(gsbox, "isXPCShell", {get: function () isXPCShell});
+  if (isXPCShell) {
+    Object.defineProperty(gsbox, "isXPCShell", {get: function () true});
+  } else {
+    Object.defineProperty(gsbox, "isXPCShell", {get: function () false});
+  }
+
   Object.defineProperty(gsbox, "contentURL", {get: function () urlMain});
 
   // `tieto` API: ties method to object, so it always has correct `this`
-  // you may specify additional arguments that will be always there
+  // you may specify additional arguments that will be always passed unchanged
   function tieto (obj, method) {
     let mt;
     if (typeof(obj) === "undefined") throw new Error("object or `null` expected");
@@ -133,9 +136,6 @@
   }, logErr);
   Object.defineProperty(gsbox, "logException", {get: function () sb_logException});
 
-  //let conlogEnabled = true;
-  //Object.defineProperty(gsbox, "conlogEnabled", {get: tieto(this, function () this.conlogEnabled)});
-
   // https://developer.mozilla.org/en-US/docs/XPCOM_Interface_Reference/nsIConsoleService#logStringMessage() - wstring / wide string
   const conService = Cc["@mozilla.org/consoleservice;1"].getService(Ci.nsIConsoleService);
   const oldconlog = (isXPCShell ? global.conlog : null);
@@ -283,7 +283,11 @@
     if (rev === false) {
       // now load main file
       let loadmain = ("__dontLoadMainJS" in global ? !global.__dontLoadMainJS : true);
-      if (loadmain) gsbox.include(urlJS+"main.js");
+      if (loadmain) {
+        gsbox.include("mainjs:prefs/prefs.js"); // define default extension preferences
+        gsbox.require("mainjs:prefsengine.js");
+        gsbox.include("mainjs:main.js");
+      }
     }
     let idx = (rev ? list.length : -1);
     for (;;) {
diff --git a/main/main.js b/main/main.js
index 27bcee5..c78602d 100644
--- a/main/main.js
+++ b/main/main.js
@@ -7,8 +7,8 @@
  * To Public License, Version 2, as published by Sam Hocevar. See
  * http://www.wtfpl.net/txt/copying/ for more details.
  */
+// main extension loader -- user-defined code
 include("utils");
-require("mainjs:prefs"); // this does global exports; HACK
 
 
 let {PackageDB} = require("pkg/packagedb");
diff --git a/main/prefs/prefs.js b/main/prefs/prefs.js
new file mode 100644
index 0000000..5cbbfcd
--- /dev/null
+++ b/main/prefs/prefs.js
@@ -0,0 +1,35 @@
+/* coded by Ketmar // Invisible Vector (psyc://ketmar.no-ip.org/~Ketmar)
+ * Understanding is not required. Only obedience.
+ *
+ * This program is free software. It comes without any warranty, to
+ * the extent permitted by applicable law. You can redistribute it
+ * and/or modify it under the terms of the Do What The Fuck You Want
+ * To Public License, Version 2, as published by Sam Hocevar. See
+ * http://www.wtfpl.net/txt/copying/ for more details.
+ */
+////////////////////////////////////////////////////////////////////////////////
+const PREFS_BRANCH = "extensions.guerilla.";
+
+const PREFS = {
+  openErrorConsoleOnStartup: false,
+  debugMode: false,
+  debugCache: false,
+  logEnabled: true,
+  active: true,
+  // all pathes are relative to profile dir
+  jsdir: "guerillajs",
+  libdir: "guerillajs_libs",
+  dbdir: "guerillajs_data",
+  pkgdir: "guerillajs_packages",
+  pkgdbdir: "guerillajs_packages/_0data",
+  pkgtempdir: "guerillajs_packages/_0temp",
+};
+
+const PREFS_DIR_NAMES = {
+  jsdir: "JSDir",
+  libdir: "LibDir",
+  dbdir: "DBDir",
+  pkgdir: "PkgDir",
+  pkgdbdir: "PkgDBDir",
+  pkgtempdir: "PkgTempDir",
+};
diff --git a/main/prefs.js b/main/prefsengine.js
similarity index 77%
rename from main/prefs.js
rename to main/prefsengine.js
index 7a955b5..1e157ee 100644
--- a/main/prefs.js
+++ b/main/prefsengine.js
@@ -8,36 +8,12 @@
  * http://www.wtfpl.net/txt/copying/ for more details.
  */
 ////////////////////////////////////////////////////////////////////////////////
-const PREF_BRANCH = "extensions.guerilla.";
-
-const PREFS = {
-  openErrorConsoleOnStartup: false,
-  debugMode: false,
-  debugCache: false,
-  logEnabled: true,
-  active: true,
-  // all pathes are relative to profile dir
-  jsdir: "guerillajs",
-  libdir: "guerillajs_libs",
-  dbdir: "guerillajs_data",
-  pkgdir: "guerillajs_packages",
-  pkgdbdir: "guerillajs_packages/_0data",
-  pkgtempdir: "guerillajs_packages/_0temp",
-};
-
-const dirNames = {
-  jsdir: "JSDir",
-  libdir: "LibDir",
-  dbdir: "DBDir",
-  pkgdir: "PkgDir",
-  pkgdbdir: "PkgDBDir",
-  pkgtempdir: "PkgTempDir",
-};
+// user code should define `PREFS_BRANCH`, `PREFS` and `PREFS_DIR_NAMES`
 
 
 ////////////////////////////////////////////////////////////////////////////////
 function setDefaultPrefs () {
-  let branch = Services.prefs.getDefaultBranch(PREF_BRANCH);
+  let branch = Services.prefs.getDefaultBranch(PREFS_BRANCH);
   for (let [key, val] in Iterator(PREFS)) {
     switch (typeof(val)) {
       case "boolean": branch.setBoolPref(key, val); break;
@@ -57,11 +33,11 @@ function getUserXXDir (name, createit) {
     // cached
     res = res.clone();
   } else {
-    if (!(name in dirNames)) throw new Error("unknown 'known' dir: '"+name+"'");
+    if (!(name in PREFS_DIR_NAMES)) throw new Error("unknown 'known' dir: '"+name+"'");
     //logError("getting dir '"+name+"'");
     // new, cache it
     let dn = "";
-    try { dn = Services.prefs.getCharPref(PREF_BRANCH+name); } catch (e) {}
+    try { dn = Services.prefs.getCharPref(PREFS_BRANCH+name); } catch (e) {}
     if (dn.length && dn[0] == '/') {
       res = Cc["@mozilla.org/file/local;1"].createInstance(Ci.nsILocalFile);
       res.initWithPath(dn);
@@ -81,11 +57,11 @@ function getUserXXDir (name, createit) {
 exportsGlobal.resetUserDirCache = function () { knownDirs = {}; };
 
 // build dir getters
-(function () {
-  for (let [iname, oname] in Iterator(dirNames)) {
+if ("PREFS_DIR_NAMES" in this) {
+  for (let [iname, oname] in Iterator(PREFS_DIR_NAMES)) {
     exportsGlobal["getUser"+oname] = tieto(this, getUserXXDir, iname, true);
   }
-})();
+}
 
 
 ////////////////////////////////////////////////////////////////////////////////
@@ -93,9 +69,9 @@ function getAddonPref (name) {
   if (typeof(name) == "string" && (name in PREFS)) {
     try {
       switch (typeof(PREFS[name])) {
-        case "boolean": return Services.prefs.getBoolPref(PREF_BRANCH+name);
-        case "number": return Services.prefs.getIntPref(PREF_BRANCH+name);
-        case "string": return Services.prefs.getCharPref(PREF_BRANCH+name);
+        case "boolean": return Services.prefs.getBoolPref(PREFS_BRANCH+name);
+        case "number": return Services.prefs.getIntPref(PREFS_BRANCH+name);
+        case "string": return Services.prefs.getCharPref(PREFS_BRANCH+name);
       }
     } catch (e) {}
     return PREFS[name];
@@ -110,9 +86,9 @@ function setAddonPref (name, val) {
   if (typeof(name) == "string" && (name in PREFS)) {
     try {
       switch (typeof(PREFS[name])) {
-        case "boolean": val = !!val; Services.prefs.setBoolPref(PREF_BRANCH+name, val); break;
-        case "number": val = parseInt(val); Services.prefs.setIntPref(PREF_BRANCH+name, val); break;
-        case "string": val = ""+val; Services.prefs.setCharPref(PREF_BRANCH+name, val); break;
+        case "boolean": val = !!val; Services.prefs.setBoolPref(PREFS_BRANCH+name, val); break;
+        case "number": val = parseInt(val); Services.prefs.setIntPref(PREFS_BRANCH+name, val); break;
+        case "string": val = ""+val; Services.prefs.setCharPref(PREFS_BRANCH+name, val); break;
       }
       return val;
     } catch (e) {}
@@ -150,10 +126,10 @@ exportsGlobal.addonOptions = addonOptions;
 
 
 ////////////////////////////////////////////////////////////////////////////////
-let PREF_OBSERVER = {
+let prefObserver = {
   observe: function (aSubject, aTopic, aData) {
     //conlog("data: ["+aData+"]; subj="+aSubject+"; topic="+aTopic);
-    //let name = aData.substr(PREF_BRANCH.length);
+    //let name = aData.substr(PREFS_BRANCH.length);
     //conlog("name: ["+name+"]");
     //let prf = Services.prefs;
     //if (name == "openErrorConsoleOnStartup") addonOptions.openConsole = prf.getBoolPref(aData);
@@ -169,11 +145,10 @@ let PREF_OBSERVER = {
 ////////////////////////////////////////////////////////////////////////////////
 registerStartupHook("preferences", function () {
   setDefaultPrefs(); // always set the default prefs as they disappear on restart
-  Services.prefs.addObserver(PREF_BRANCH, PREF_OBSERVER, false);
-  //logError(getUserLibDir().path);
+  Services.prefs.addObserver(PREFS_BRANCH, prefObserver, false);
 });
 
 
 registerShutdownHook("preferences", function () {
-  Services.prefs.removeObserver(PREF_BRANCH, PREF_OBSERVER);
+  Services.prefs.removeObserver(PREFS_BRANCH, prefObserver);
 });
-- 
2.11.4.GIT