Create a minimal settings UI

adblockplus/Api.jsm

 /*
  * This file is part of Adblock Plus <https://adblockplus.org/>,
  * Copyright (C) 2006-2015 Eyeo GmbH
  *
  * Adblock Plus is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License version 3 as
  * published by the Free Software Foundation.
  *
  * Adblock Plus 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 Adblock Plus.  If not, see <http://www.gnu.org/licenses/>.
  */
 
 var EXPORTED_SYMBOLS = ["AdblockPlusApi"];
 
 const Cc = Components.classes;
 const Ci = Components.interfaces;
 const Cr = Components.results;
 const Cu = Components.utils;
 
 Cu.import("resource://gre/modules/Services.jsm");
+Cu.import("resource://gre/modules/Messaging.jsm");
 
 function require(module)
 {
   let result = {};
   result.wrappedJSObject = result;
   Services.obs.notifyObservers(result, "adblockplus-require", module);
   return result.exports;
 }
 
+let {FilterNotifier} = require("filterNotifier");
 let {FilterStorage} = require("filterStorage");
 let {Prefs} = require("prefs");
 let {UI} = require("ui");
 
+let {FilterNotifier} = require("filterNotifier");
+
 var AdblockPlusApi =
 {
+  get filtersLoaded()

[René Jeschke, 2015/03/22 15:32:59]

Done.

+  {
+    return filtersLoaded;
+  },
   get acceptableAdsEnabled()
   {
     return FilterStorage.subscriptions.some(
       (subscription) => subscription.url == Prefs.subscriptions_exceptionsurl);
   },
   set acceptableAdsEnabled(acceptableAdsEnabled)
   {
     if (acceptableAdsEnabled != AdblockPlusApi.acceptableAdsEnabled)
       UI.toggleAcceptableAds();
   }
 };
+
+
+FilterNotifier.addListener(function filterListener(action)
+{
+  if (action != "load")
+    return;
+
+  filtersLoaded = true;
+  FilterNotifier.removeListener(filterListener);
+});
+
+RequestService.addListener(function(data)

[Felix Dahlke, 2015/03/22 13:52:34]

IMHO it would be cleaner to move this to a dedicated function
(AdblockPlusApi.initCommunication, or something better :D) - it's not too
obvious that we have to import Api.jsm early enough.

+{
+  if (!data)
+    return {"success" : false, "error" : "misformed request"};
+
+  if (data["action"] == "query_ready_state")

[René Jeschke, 2015/03/22 15:32:59]

As you suggest ( \/ ) that we should use 'get' and 'set', I vote for a _uniform_
naming scheme, i.e. getFiltersLoaded ... even if there is no 'set'.

+    return {"success" : true, "value" : AdblockPlusApi.filtersLoaded};
+
+  if (!AdblockPlusApi.filtersLoaded)
+    return {"success" : false, "error" : "filters not loaded"};
+
+  switch (data["action"])
+  {
+    case "query_acceptable_ads_state":

[René Jeschke, 2015/03/22 15:32:59]

Well, I could rename this, doesn't make such a difference ... and also does not
make the layer thicker or thinner, though, but here you go.

+      return {"success" : true, "value" : AdblockPlusApi.acceptableAdsEnabled};
+    case "change_acceptable_ads_state":

[Felix Dahlke, 2015/03/22 13:52:34]

Likewise - setAcceptableAdsEnabled"?

[René Jeschke, 2015/03/22 15:32:59]

Well, ok.

+      if ("enable" in data)
+      {
+        AdblockPlusApi.acceptableAdsEnabled = !!data["enable"];
+        return {"success" : true};
+      }
+      return {"success" : false, "error" : "misformed request"};
+    default:
+      return {"success" : false, "error" : "unknown action '" + data["action"] + "'"};
+  }
+  return {"success" : false, "error" : "misformed request"};
+}, "AdblockPlus:Api");