give specific message handlers priority over default one

meta/crx/vapi-background.js

@@ -19,9 +19,9 @@
     Home: https://github.com/gorhill/uBlock
 */
 
-// For background page
+/* global self */
 
-/* global SafariBrowserTab, Services, XPCOMUtils */
+// For background page
 
 /******************************************************************************/
 
@@ -44,60 +44,63 @@ vAPI.storage = chrome.storage.local;
 
 /******************************************************************************/
 
-vAPI.tabs = {
-    registerListeners: function() {
-        if (typeof this.onNavigation === 'function') {
+vAPI.tabs = {};
+
+/******************************************************************************/
+
+vAPI.tabs.registerListeners = function() {
+    if ( typeof this.onNavigation === 'function' ) {
         chrome.webNavigation.onCommitted.addListener(this.onNavigation);
     }
 
-        if (typeof this.onUpdated === 'function') {
+    if ( typeof this.onUpdated === 'function' ) {
         chrome.tabs.onUpdated.addListener(this.onUpdated);
     }
 
-        if (typeof this.onClosed === 'function') {
+    if ( typeof this.onClosed === 'function' ) {
         chrome.tabs.onRemoved.addListener(this.onClosed);
     }
 
-        if (typeof this.onPopup === 'function') {
+    if ( typeof this.onPopup === 'function' ) {
         chrome.webNavigation.onCreatedNavigationTarget.addListener(this.onPopup);
     }
-    },
+};
 
-    get: function(tabId, callback) {
-        if (tabId === null) {
-            chrome.tabs.query(
-                {
-                    active: true,
-                    currentWindow: true
-                },
-                function(tabs) {
-                    callback(tabs[0]);
-                }
-            );
-        }
-        else {
+/******************************************************************************/
+
+vAPI.tabs.get = function(tabId, callback) {
+    if ( tabId !== null ) {
         chrome.tabs.get(tabId, callback);
+        return;
     }
-    },
-    /*open: function(details) {
-        // to keep incognito context?
-        chrome.windows.getCurrent(function(win) {
-            details.windowId = win.windowId;
-            chrome.tabs.create(details);
-        });
-    },*/
-    open: function(details) {
-        if (!details.url) {
+    var onTabReceived = function(tabs) {
+        callback(tabs[0]);
+    };
+    chrome.tabs.query({ active: true, currentWindow: true }, onTabReceived);
+};
+
+/******************************************************************************/
+
+// properties of the details object:
+//   url: 'URL', // the address that will be opened
+//   tabId: 1, // the tab is used if set, instead of creating a new one
+//   index: -1, // undefined: end of the list, -1: following tab, or after index
+//   active: false, // opens the tab in background - true and undefined: foreground
+//   select: true // if a tab is already opened with that url, then select it instead of opening a new one
+
+vAPI.tabs.open = function(details) {
+    var url = details.url;
+    if ( typeof url !== 'string' || url === '' ) {
         return null;
     }
     // extension pages
-        else if (!details.url.match(/^\w{2,20}:/)) {
-            details.url = vAPI.getURL(details.url);
+    if ( /^[\w-]{2,}:/.test(url) !== true ) {
+        url = vAPI.getURL(url);
     }
 
-        // dealing with Chrome's asynhronous API
+    // dealing with Chrome's asynchronous API
     var wrapper = function() {
-            if (details.active === undefined) {
+        if ( details.active === undefined ) {
             details.active = true;
         }
 
@@ -107,7 +110,7 @@ vAPI.tabs = {
                 active: !!details.active
             };
 
-                if (details.tabId) {
+            if ( details.tabId ) {
                 // update doesn't accept index, must use move
                 chrome.tabs.update(details.tabId, _details, function(tab) {
                     // if the tab doesn't exist
@@ -117,9 +120,8 @@ vAPI.tabs = {
                         chrome.tabs.move(tab.id, {index: details.index});
                     }
                 });
-                }
-                else {
-                    if (details.index !== undefined) {
+            } else {
+                if ( details.index !== undefined ) {
                     _details.index = details.index;
                 }
 
@@ -127,12 +129,11 @@ vAPI.tabs = {
             }
         };
 
-            if (details.index === -1) {
+        if ( details.index === -1 ) {
             vAPI.tabs.get(null, function(tab) {
-                    if (tab) {
+                if ( tab ) {
                     details.index = tab.index + 1;
-                    }
-                    else {
+                } else {
                     delete details.index;
                 }
 
@@ -144,22 +145,19 @@ vAPI.tabs = {
         }
     };
 
-        if (details.select) {
-            // note that currentWindow may be even the window of Developer Tools
-            // so, test with setTimeout...
-            chrome.tabs.query({currentWindow: true}, function(tabs) {
+    if ( details.select ) {
+        chrome.tabs.query({ currentWindow: true }, function(tabs) {
             var url = details.url.replace(rgxHash, '');
             // this is questionable
             var rgxHash = /#.*/;
-
-                tabs = tabs.some(function(tab) {
-                    if (tab.url.replace(rgxHash, '') === url) {
-                        chrome.tabs.update(tab.id, {active: true});
+            var selected = tabs.some(function(tab) {
+                if ( tab.url.replace(rgxHash, '') === url ) {
+                    chrome.tabs.update(tab.id, { active: true });
                     return true;
                 }
             });
 
-                if (!tabs) {
+            if ( selected.length === 0 ) {
                 wrapper();
             }
         });
@@ -167,20 +165,30 @@ vAPI.tabs = {
     else {
         wrapper();
     }
-    },
-    close: chrome.tabs.remove.bind(chrome.tabs),
-    injectScript: function(tabId, details, callback) {
-        if (!callback) {
+};
+
+/******************************************************************************/
+
+vAPI.tabs.remove = function(tabId) {
+    var onTabRemoved = function() {
+        if ( vAPI.lastError() ) {
+        }
+    };
+    chrome.tabs.remove(tabId, onTabRemoved);
+};
+
+/******************************************************************************/
+
+vAPI.tabs.injectScript = function(tabId, details, callback) {
+    if ( typeof callback !== 'function' ) {
         callback = function(){};
     }
 
-        if (tabId) {
+    if ( tabId ) {
         chrome.tabs.executeScript(tabId, details, callback);
-        }
-        else {
+    } else {
         chrome.tabs.executeScript(details, callback);
     }
-    }
 };
 
 /******************************************************************************/
@@ -197,9 +205,7 @@ vAPI.setIcon = function(tabId, img, badge) {
         if ( vAPI.lastError() ) {
             return;
         }
-
         chrome.browserAction.setBadgeText({ tabId: tabId, text: badge });
-
         if ( badge !== '' ) {
             chrome.browserAction.setBadgeBackgroundColor({ tabId: tabId, color: '#666' });
         }
@@ -212,18 +218,19 @@ vAPI.setIcon = function(tabId, img, badge) {
 vAPI.messaging = {
     ports: {},
     listeners: {},
-    connector: null,
+    defaultHandler: null,
+    UNHANDLED: 'vAPI.messaging.notHandled'
+};
 
-    listen: function(listenerName, callback) {
+/******************************************************************************/
+
+vAPI.messaging.listen = function(listenerName, callback) {
     this.listeners[listenerName] = callback;
-    },
+};
 
-    setup: function(connector) {
-        if ( this.connector ) {
-            return;
-        }
+/******************************************************************************/
 
-        this.connector = function(port) {
+vAPI.messaging.onConnect = function(port) {
     var onMessage = function(request) {
         var callback = function(response) {
             if ( vAPI.lastError() || response === undefined ) {
@@ -239,19 +246,23 @@ vAPI.messaging = {
             }
         };
 
+        // Specific handler
+        var r;
+        var listener = vAPI.messaging.listeners[request.portName];
+        if ( typeof listener === 'function' ) {
+            r = listener(request.msg, port.sender, callback);
+        }
+        if ( r !== vAPI.messaging.UNHANDLED ) {
+            return;
+        }
+
         // Default handler
-                var listener = connector(request.msg, port.sender, callback);
-                if ( listener !== null ) {
+        r = vAPI.messaging.defaultHandler(request.msg, port.sender, callback);
+        if ( r !== vAPI.messaging.UNHANDLED ) {
             return;
         }
 
-                // Specific handler
-                listener = vAPI.messaging.listeners[request.portName];
-                if ( typeof listener === 'function' ) {
-                    listener(request.msg, port.sender, callback);
-                } else {
         console.error('µBlock> messaging > unknown request: %o', request);
-                }
     };
 
     var onDisconnect = function(port) {
@@ -263,20 +274,37 @@ vAPI.messaging = {
     port.onDisconnect.addListener(onDisconnect);
     port.onMessage.addListener(onMessage);
     vAPI.messaging.ports[port.name] = port;
+};
+
+/******************************************************************************/
+
+vAPI.messaging.setup = function(defaultHandler) {
+    // Already setup?
+    if ( this.defaultHandler !== null ) {
+        return;
+    }
+
+    if ( typeof defaultHandler !== 'function' ) {
+        defaultHandler = function(){ return null; };
     };
+    this.defaultHandler = defaultHandler;
 
-        chrome.runtime.onConnect.addListener(this.connector);
-    },
+    chrome.runtime.onConnect.addListener(this.onConnect);
+};
+
+/******************************************************************************/
 
-    broadcast: function(message) {
-        message = {
+vAPI.messaging.broadcast = function(message) {
+    var messageWrapper = {
         broadcast: true,
         msg: message
     };
 
     for ( var portName in this.ports ) {
-            this.ports[portName].postMessage(message);
+        if ( this.ports.hasOwnProperty(portName) === false ) {
+            continue;
         }
+        this.ports[portName].postMessage(messageWrapper);
     }
 };